Kafka / Client / create_vpc_connection
create_vpc_connection#
- Kafka.Client.create_vpc_connection(**kwargs)#
Creates a new MSK VPC connection.
See also: AWS API Documentation
Request Syntax
response = client.create_vpc_connection( TargetClusterArn='string', Authentication='string', VpcId='string', ClientSubnets=[ 'string', ], SecurityGroups=[ 'string', ], Tags={ 'string': 'string' } )
- Parameters:
TargetClusterArn (string) –
[REQUIRED]
The cluster Amazon Resource Name (ARN) for the VPC connection.
Authentication (string) –
[REQUIRED]
The authentication type of VPC connection.
VpcId (string) –
[REQUIRED]
The VPC ID of VPC connection.
ClientSubnets (list) –
[REQUIRED]
The list of client subnets.
(string) –
SecurityGroups (list) –
[REQUIRED]
The list of security groups.
(string) –
Tags (dict) –
A map of tags for the VPC connection.
(string) –
(string) –
- Return type:
dict
- Returns:
Response Syntax
{ 'VpcConnectionArn': 'string', 'State': 'CREATING'|'AVAILABLE'|'INACTIVE'|'DEACTIVATING'|'DELETING'|'FAILED'|'REJECTED'|'REJECTING', 'Authentication': 'string', 'VpcId': 'string', 'ClientSubnets': [ 'string', ], 'SecurityGroups': [ 'string', ], 'CreationTime': datetime(2015, 1, 1), 'Tags': { 'string': 'string' } }
Response Structure
(dict) –
200 response
VpcConnectionArn (string) –
The VPC connection ARN.
State (string) –
The State of Vpc Connection.
Authentication (string) –
The authentication type of VPC connection.
VpcId (string) –
The VPC ID of the VPC connection.
ClientSubnets (list) –
The list of client subnets.
(string) –
SecurityGroups (list) –
The list of security groups.
(string) –
CreationTime (datetime) –
The creation time of VPC connection.
Tags (dict) –
A map of tags for the VPC connection.
(string) –
(string) –
Exceptions
Kafka.Client.exceptions.BadRequestException
Kafka.Client.exceptions.InternalServerErrorException
Kafka.Client.exceptions.UnauthorizedException
Kafka.Client.exceptions.ForbiddenException
Kafka.Client.exceptions.ServiceUnavailableException
Kafka.Client.exceptions.TooManyRequestsException