KinesisAnalyticsV2 / Client / add_application_vpc_configuration

add_application_vpc_configuration#

KinesisAnalyticsV2.Client.add_application_vpc_configuration(**kwargs)#

Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use VPCs to store and access resources securely.

Note the following about VPC configurations for Kinesis Data Analytics applications:

  • VPC configurations are not supported for SQL applications.

  • When a VPC is added to a Kinesis Data Analytics application, the application can no longer be accessed from the Internet directly. To enable Internet access to the application, add an Internet gateway to your VPC.

See also: AWS API Documentation

Request Syntax

response = client.add_application_vpc_configuration(
    ApplicationName='string',
    CurrentApplicationVersionId=123,
    VpcConfiguration={
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ]
    },
    ConditionalToken='string'
)
Parameters:

  • ApplicationName (string) –

    [REQUIRED]

    The name of an existing application.

  • CurrentApplicationVersionId (integer) – The version of the application to which you want to add the VPC configuration. You must provide the CurrentApplicationVersionId or the ConditionalToken. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

  • VpcConfiguration (dict) –

    [REQUIRED]

    Description of the VPC to add to the application.

    • SubnetIds (list) – [REQUIRED]

      The array of Subnet IDs used by the VPC configuration.

      • (string) –

    • SecurityGroupIds (list) – [REQUIRED]

      The array of SecurityGroup IDs used by the VPC configuration.

      • (string) –

  • ConditionalToken (string) – A value you use to implement strong concurrency for application updates. You must provide the ApplicationVersionID or the ConditionalToken. You get the application’s current ConditionalToken using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

Return type:

dict

Returns:

Response Syntax

{
    'ApplicationARN': 'string',
    'ApplicationVersionId': 123,
    'VpcConfigurationDescription': {
        'VpcConfigurationId': 'string',
        'VpcId': 'string',
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ]
    }
}

Response Structure

  • (dict) –

    • ApplicationARN (string) –

      The ARN of the application.

    • ApplicationVersionId (integer) –

      Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.

    • VpcConfigurationDescription (dict) –

      The parameters of the new VPC configuration.

      • VpcConfigurationId (string) –

        The ID of the VPC configuration.

      • VpcId (string) –

        The ID of the associated VPC.

      • SubnetIds (list) –

        The array of Subnet IDs used by the VPC configuration.

        • (string) –

      • SecurityGroupIds (list) –

        The array of SecurityGroup IDs used by the VPC configuration.

        • (string) –

Exceptions

  • KinesisAnalyticsV2.Client.exceptions.ResourceNotFoundException

  • KinesisAnalyticsV2.Client.exceptions.ResourceInUseException

  • KinesisAnalyticsV2.Client.exceptions.InvalidArgumentException

  • KinesisAnalyticsV2.Client.exceptions.ConcurrentModificationException

  • KinesisAnalyticsV2.Client.exceptions.InvalidApplicationConfigurationException