1. Packages
  2. AWS
  3. API Docs
  4. msk
  5. getVpcConnection
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.msk.getVpcConnection

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Get information on an Amazon MSK VPC Connection.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.msk.getVpcConnection({
        arn: exampleAwsMskVpcConnection.arn,
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.msk.get_vpc_connection(arn=example_aws_msk_vpc_connection["arn"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/msk"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := msk.LookupVpcConnection(ctx, &msk.LookupVpcConnectionArgs{
    			Arn: exampleAwsMskVpcConnection.Arn,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Aws.Msk.GetVpcConnection.Invoke(new()
        {
            Arn = exampleAwsMskVpcConnection.Arn,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.msk.MskFunctions;
    import com.pulumi.aws.msk.inputs.GetVpcConnectionArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = MskFunctions.getVpcConnection(GetVpcConnectionArgs.builder()
                .arn(exampleAwsMskVpcConnection.arn())
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: aws:msk:getVpcConnection
          Arguments:
            arn: ${exampleAwsMskVpcConnection.arn}
    

    Using getVpcConnection

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getVpcConnection(args: GetVpcConnectionArgs, opts?: InvokeOptions): Promise<GetVpcConnectionResult>
    function getVpcConnectionOutput(args: GetVpcConnectionOutputArgs, opts?: InvokeOptions): Output<GetVpcConnectionResult>
    def get_vpc_connection(arn: Optional[str] = None,
                           tags: Optional[Mapping[str, str]] = None,
                           opts: Optional[InvokeOptions] = None) -> GetVpcConnectionResult
    def get_vpc_connection_output(arn: Optional[pulumi.Input[str]] = None,
                           tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetVpcConnectionResult]
    func LookupVpcConnection(ctx *Context, args *LookupVpcConnectionArgs, opts ...InvokeOption) (*LookupVpcConnectionResult, error)
    func LookupVpcConnectionOutput(ctx *Context, args *LookupVpcConnectionOutputArgs, opts ...InvokeOption) LookupVpcConnectionResultOutput

    > Note: This function is named LookupVpcConnection in the Go SDK.

    public static class GetVpcConnection 
    {
        public static Task<GetVpcConnectionResult> InvokeAsync(GetVpcConnectionArgs args, InvokeOptions? opts = null)
        public static Output<GetVpcConnectionResult> Invoke(GetVpcConnectionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVpcConnectionResult> getVpcConnection(GetVpcConnectionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:msk/getVpcConnection:getVpcConnection
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Arn string
    ARN of the VPC Connection.
    Tags Dictionary<string, string>
    Map of key-value pairs assigned to the VPC Connection.
    Arn string
    ARN of the VPC Connection.
    Tags map[string]string
    Map of key-value pairs assigned to the VPC Connection.
    arn String
    ARN of the VPC Connection.
    tags Map<String,String>
    Map of key-value pairs assigned to the VPC Connection.
    arn string
    ARN of the VPC Connection.
    tags {[key: string]: string}
    Map of key-value pairs assigned to the VPC Connection.
    arn str
    ARN of the VPC Connection.
    tags Mapping[str, str]
    Map of key-value pairs assigned to the VPC Connection.
    arn String
    ARN of the VPC Connection.
    tags Map<String>
    Map of key-value pairs assigned to the VPC Connection.

    getVpcConnection Result

    The following output properties are available:

    Arn string
    Authentication string
    The authentication type for the client VPC Connection.
    ClientSubnets List<string>
    The list of subnets in the client VPC.
    Id string
    The provider-assigned unique ID for this managed resource.
    SecurityGroups List<string>
    The security groups attached to the ENIs for the broker nodes.
    Tags Dictionary<string, string>
    Map of key-value pairs assigned to the VPC Connection.
    TargetClusterArn string
    The Amazon Resource Name (ARN) of the cluster.
    VpcId string
    The VPC ID of the remote client.
    Arn string
    Authentication string
    The authentication type for the client VPC Connection.
    ClientSubnets []string
    The list of subnets in the client VPC.
    Id string
    The provider-assigned unique ID for this managed resource.
    SecurityGroups []string
    The security groups attached to the ENIs for the broker nodes.
    Tags map[string]string
    Map of key-value pairs assigned to the VPC Connection.
    TargetClusterArn string
    The Amazon Resource Name (ARN) of the cluster.
    VpcId string
    The VPC ID of the remote client.
    arn String
    authentication String
    The authentication type for the client VPC Connection.
    clientSubnets List<String>
    The list of subnets in the client VPC.
    id String
    The provider-assigned unique ID for this managed resource.
    securityGroups List<String>
    The security groups attached to the ENIs for the broker nodes.
    tags Map<String,String>
    Map of key-value pairs assigned to the VPC Connection.
    targetClusterArn String
    The Amazon Resource Name (ARN) of the cluster.
    vpcId String
    The VPC ID of the remote client.
    arn string
    authentication string
    The authentication type for the client VPC Connection.
    clientSubnets string[]
    The list of subnets in the client VPC.
    id string
    The provider-assigned unique ID for this managed resource.
    securityGroups string[]
    The security groups attached to the ENIs for the broker nodes.
    tags {[key: string]: string}
    Map of key-value pairs assigned to the VPC Connection.
    targetClusterArn string
    The Amazon Resource Name (ARN) of the cluster.
    vpcId string
    The VPC ID of the remote client.
    arn str
    authentication str
    The authentication type for the client VPC Connection.
    client_subnets Sequence[str]
    The list of subnets in the client VPC.
    id str
    The provider-assigned unique ID for this managed resource.
    security_groups Sequence[str]
    The security groups attached to the ENIs for the broker nodes.
    tags Mapping[str, str]
    Map of key-value pairs assigned to the VPC Connection.
    target_cluster_arn str
    The Amazon Resource Name (ARN) of the cluster.
    vpc_id str
    The VPC ID of the remote client.
    arn String
    authentication String
    The authentication type for the client VPC Connection.
    clientSubnets List<String>
    The list of subnets in the client VPC.
    id String
    The provider-assigned unique ID for this managed resource.
    securityGroups List<String>
    The security groups attached to the ENIs for the broker nodes.
    tags Map<String>
    Map of key-value pairs assigned to the VPC Connection.
    targetClusterArn String
    The Amazon Resource Name (ARN) of the cluster.
    vpcId String
    The VPC ID of the remote client.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi