We recommend new projects start with resources from the AWS provider.
aws-native.msk.VpcConnection
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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.
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The VpcConnection resource accepts the following input properties:
- Authentication
Pulumi.Aws Native. Msk. Vpc Connection Authentication 
- 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.
- TargetCluster stringArn 
- The Amazon Resource Name (ARN) of the target cluster
- VpcId string
- The VPC ID of the remote client.
- Dictionary<string, string>
- An arbitrary set of tags (key-value pairs) you specify while creating the VPC connection.
- Authentication
VpcConnection Authentication 
- 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.
- TargetCluster stringArn 
- The Amazon Resource Name (ARN) of the target cluster
- VpcId string
- The VPC ID of the remote client.
- map[string]string
- An arbitrary set of tags (key-value pairs) you specify while creating the VPC connection.
- authentication
VpcConnection Authentication 
- 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.
- targetCluster StringArn 
- The Amazon Resource Name (ARN) of the target cluster
- vpcId String
- The VPC ID of the remote client.
- Map<String,String>
- An arbitrary set of tags (key-value pairs) you specify while creating the VPC connection.
- authentication
VpcConnection Authentication 
- 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.
- targetCluster stringArn 
- The Amazon Resource Name (ARN) of the target cluster
- vpcId string
- The VPC ID of the remote client.
- {[key: string]: string}
- An arbitrary set of tags (key-value pairs) you specify while creating the VPC connection.
- authentication
VpcConnection Authentication 
- 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_ strarn 
- The Amazon Resource Name (ARN) of the target cluster
- vpc_id str
- The VPC ID of the remote client.
- Mapping[str, str]
- An arbitrary set of tags (key-value pairs) you specify while 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.
- targetCluster StringArn 
- The Amazon Resource Name (ARN) of the target cluster
- vpcId String
- The VPC ID of the remote client.
- Map<String>
- An arbitrary set of tags (key-value pairs) you specify while creating the VPC connection.
Outputs
All input properties are implicitly available as output properties. Additionally, the VpcConnection resource produces the following output properties:
Supporting Types
VpcConnectionAuthentication, VpcConnectionAuthenticationArgs      
- SaslIam 
- SASL_IAM
- SaslScram 
- SASL_SCRAM
- Tls
- TLS
- VpcConnection Authentication Sasl Iam 
- SASL_IAM
- VpcConnection Authentication Sasl Scram 
- SASL_SCRAM
- VpcConnection Authentication Tls 
- 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
We recommend new projects start with resources from the AWS provider.