Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. msk
  5. VpcConnection

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.msk.VpcConnection

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::MSK::VpcConnection

    Create VpcConnection Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VpcConnection(name: string, args: VpcConnectionArgs, opts?: CustomResourceOptions);
    @overload
def VpcConnection(resource_name: str,
                  args: VpcConnectionArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def VpcConnection(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  authentication: Optional[VpcConnectionAuthentication] = None,
                  client_subnets: Optional[Sequence[str]] = None,
                  security_groups: Optional[Sequence[str]] = None,
                  target_cluster_arn: Optional[str] = None,
                  vpc_id: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None)
    func NewVpcConnection(ctx *Context, name string, args VpcConnectionArgs, opts ...ResourceOption) (*VpcConnection, error)
    public VpcConnection(string name, VpcConnectionArgs args, CustomResourceOptions? opts = null)
    public VpcConnection(String name, VpcConnectionArgs args)
public VpcConnection(String name, VpcConnectionArgs args, CustomResourceOptions options)

    type: aws-native:msk:VpcConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VpcConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VpcConnectionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VpcConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpcConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpcConnectionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const vpcConnectionResource = new aws_native.msk.VpcConnection("vpcConnectionResource", {
    authentication: aws_native.msk.VpcConnectionAuthentication.SaslIam,
    clientSubnets: ["string"],
    securityGroups: ["string"],
    targetClusterArn: "string",
    vpcId: "string",
    tags: {
        string: "string",
    },
});

    Coming soon!

    VpcConnection Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The VpcConnection resource accepts the following input properties:

    Authentication Pulumi.AwsNative.Msk.VpcConnectionAuthentication
    The type of private link authentication.
    ClientSubnets List<string>
    The list of subnets in the client VPC to connect to.
    SecurityGroups List<string>
    The security groups to attach to the ENIs for the broker nodes.
    TargetClusterArn string
    The Amazon Resource Name (ARN) of the target cluster
    VpcId string
    The VPC id of the remote client.
    Tags Dictionary<string, string>
    Create tags when creating the VPC connection.
    Authentication VpcConnectionAuthentication
    The type of private link authentication.
    ClientSubnets []string
    The list of subnets in the client VPC to connect to.
    SecurityGroups []string
    The security groups to attach to the ENIs for the broker nodes.
    TargetClusterArn string
    The Amazon Resource Name (ARN) of the target cluster
    VpcId string
    The VPC id of the remote client.
    Tags map[string]string
    Create tags when creating the VPC connection.
    authentication VpcConnectionAuthentication
    The type of private link authentication.
    clientSubnets List<String>
    The list of subnets in the client VPC to connect to.
    securityGroups List<String>
    The security groups to attach to the ENIs for the broker nodes.
    targetClusterArn String
    The Amazon Resource Name (ARN) of the target cluster
    vpcId String
    The VPC id of the remote client.
    tags Map<String,String>
    Create tags when creating the VPC connection.
    authentication VpcConnectionAuthentication
    The type of private link authentication.
    clientSubnets string[]
    The list of subnets in the client VPC to connect to.
    securityGroups string[]
    The security groups to attach to the ENIs for the broker nodes.
    targetClusterArn string
    The Amazon Resource Name (ARN) of the target cluster
    vpcId string
    The VPC id of the remote client.
    tags {[key: string]: string}
    Create tags when creating the VPC connection.
    authentication VpcConnectionAuthentication
    The type of private link authentication.
    client_subnets Sequence[str]
    The list of subnets in the client VPC to connect to.
    security_groups Sequence[str]
    The security groups to attach to the ENIs for the broker nodes.
    target_cluster_arn str
    The Amazon Resource Name (ARN) of the target cluster
    vpc_id str
    The VPC id of the remote client.
    tags Mapping[str, str]
    Create tags when creating the VPC connection.
    authentication "SASL_IAM" | "SASL_SCRAM" | "TLS"
    The type of private link authentication.
    clientSubnets List<String>
    The list of subnets in the client VPC to connect to.
    securityGroups List<String>
    The security groups to attach to the ENIs for the broker nodes.
    targetClusterArn String
    The Amazon Resource Name (ARN) of the target cluster
    vpcId String
    The VPC id of the remote client.
    tags Map<String>
    Create tags when creating the VPC connection.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VpcConnection resource produces the following output properties:

    Arn string
    The ARN of the VPC connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The ARN of the VPC connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The ARN of the VPC connection.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The ARN of the VPC connection.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The ARN of the VPC connection.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The ARN of the VPC connection.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    VpcConnectionAuthentication, VpcConnectionAuthenticationArgs

    SaslIam
    SASL_IAM
    SaslScram
    SASL_SCRAM
    Tls
    TLS
    VpcConnectionAuthenticationSaslIam
    SASL_IAM
    VpcConnectionAuthenticationSaslScram
    SASL_SCRAM
    VpcConnectionAuthenticationTls
    TLS
    SaslIam
    SASL_IAM
    SaslScram
    SASL_SCRAM
    Tls
    TLS
    SaslIam
    SASL_IAM
    SaslScram
    SASL_SCRAM
    Tls
    TLS
    SASL_IAM
    SASL_IAM
    SASL_SCRAM
    SASL_SCRAM
    TLS
    TLS
    "SASL_IAM"
    SASL_IAM
    "SASL_SCRAM"
    SASL_SCRAM
    "TLS"
    TLS

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi
    pulumi/pulumi-aws-native