Learn R Programming

paws.analytics (version 0.1.11)

kinesisanalyticsv2_add_application_vpc_configuration: Adds a Virtual Private Cloud (VPC) configuration to the application

Description

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.

Usage

kinesisanalyticsv2_add_application_vpc_configuration(ApplicationName,
  CurrentApplicationVersionId, VpcConfiguration)

Arguments

ApplicationName

[required] The name of an existing application.

CurrentApplicationVersionId

[required] The version of the application to which you want to add the VPC configuration. You can use the describe_application operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

VpcConfiguration

[required] Description of the VPC to add to the application.

Value

A list with the following syntax:

list(
  ApplicationARN = "string",
  ApplicationVersionId = 123,
  VpcConfigurationDescription = list(
    VpcConfigurationId = "string",
    VpcId = "string",
    SubnetIds = list(
      "string"
    ),
    SecurityGroupIds = list(
      "string"
    )
  )
)

Request syntax

svc$add_application_vpc_configuration(
  ApplicationName = "string",
  CurrentApplicationVersionId = 123,
  VpcConfiguration = list(
    SubnetIds = list(
      "string"
    ),
    SecurityGroupIds = list(
      "string"
    )
  )
)