AWS::MSK::VpcConnection

Create remote VPC connection.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::MSK::VpcConnection",
  "Properties" : {
      "Authentication" : String,
      "ClientSubnets" : [ String, ... ],
      "SecurityGroups" : [ String, ... ],
      "Tags" : {Key: Value, ...},
      "TargetClusterArn" : String,
      "VpcId" : String
    }
}

YAML

Type: AWS::MSK::VpcConnection
Properties:
  Authentication: String
  ClientSubnets: 
    - String
  SecurityGroups: 
    - String
  Tags: 
    Key: Value
  TargetClusterArn: String
  VpcId: String

Properties

Authentication

The type of private link authentication.

Required: Yes

Type: String

Allowed values: SASL_IAM | SASL_SCRAM | TLS

Minimum: 3

Maximum: 10

Update requires: Replacement

ClientSubnets

The list of subnets in the client VPC to connect to.

Required: Yes

Type: Array of String

Update requires: Replacement

SecurityGroups

The security groups to attach to the ENIs for the broker nodes.

Required: Yes

Type: Array of String

Update requires: Replacement

Tags

An arbitrary set of tags (key-value pairs) you specify while creating the VPC connection.

Required: No

Type: Object of String

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Update requires: No interruption

TargetClusterArn

The Amazon Resource Name (ARN) of the cluster.

Required: Yes

Type: String

Pattern: ^arn:[\w-]+:kafka:[\w-]+:\d+:cluster.*\Z

Update requires: Replacement

VpcId

The VPC ID of the remote client.

Required: Yes

Type: String

Pattern: ^(vpc-)([a-z0-9]+)\Z

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Amazon Resource Name (ARN) of the VPC connection.

For Amazon MSK VPC connection MyVpcConnection, Ref returns the ARN of the VPC connection whose logical ID is MyVpcConnection.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The ARN of the VPC connection.