| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.KinesisAnalyticsV2.AddApplicationVpcConfiguration
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.
Synopsis
- data AddApplicationVpcConfiguration = AddApplicationVpcConfiguration' {}
- newAddApplicationVpcConfiguration :: Text -> VpcConfiguration -> AddApplicationVpcConfiguration
- addApplicationVpcConfiguration_currentApplicationVersionId :: Lens' AddApplicationVpcConfiguration (Maybe Natural)
- addApplicationVpcConfiguration_conditionalToken :: Lens' AddApplicationVpcConfiguration (Maybe Text)
- addApplicationVpcConfiguration_applicationName :: Lens' AddApplicationVpcConfiguration Text
- addApplicationVpcConfiguration_vpcConfiguration :: Lens' AddApplicationVpcConfiguration VpcConfiguration
- data AddApplicationVpcConfigurationResponse = AddApplicationVpcConfigurationResponse' {}
- newAddApplicationVpcConfigurationResponse :: Int -> AddApplicationVpcConfigurationResponse
- addApplicationVpcConfigurationResponse_applicationARN :: Lens' AddApplicationVpcConfigurationResponse (Maybe Text)
- addApplicationVpcConfigurationResponse_applicationVersionId :: Lens' AddApplicationVpcConfigurationResponse (Maybe Natural)
- addApplicationVpcConfigurationResponse_vpcConfigurationDescription :: Lens' AddApplicationVpcConfigurationResponse (Maybe VpcConfigurationDescription)
- addApplicationVpcConfigurationResponse_httpStatus :: Lens' AddApplicationVpcConfigurationResponse Int
Creating a Request
data AddApplicationVpcConfiguration Source #
See: newAddApplicationVpcConfiguration smart constructor.
Constructors
| AddApplicationVpcConfiguration' | |
Fields
| |
Instances
newAddApplicationVpcConfiguration Source #
Arguments
| :: Text | |
| -> VpcConfiguration | |
| -> AddApplicationVpcConfiguration |
Create a value of AddApplicationVpcConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:currentApplicationVersionId:AddApplicationVpcConfiguration', addApplicationVpcConfiguration_currentApplicationVersionId - 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.
$sel:conditionalToken:AddApplicationVpcConfiguration', addApplicationVpcConfiguration_conditionalToken - 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.
$sel:applicationName:AddApplicationVpcConfiguration', addApplicationVpcConfiguration_applicationName - The name of an existing application.
$sel:vpcConfiguration:AddApplicationVpcConfiguration', addApplicationVpcConfiguration_vpcConfiguration - Description of the VPC to add to the application.
Request Lenses
addApplicationVpcConfiguration_currentApplicationVersionId :: Lens' AddApplicationVpcConfiguration (Maybe Natural) Source #
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.
addApplicationVpcConfiguration_conditionalToken :: Lens' AddApplicationVpcConfiguration (Maybe Text) Source #
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.
addApplicationVpcConfiguration_applicationName :: Lens' AddApplicationVpcConfiguration Text Source #
The name of an existing application.
addApplicationVpcConfiguration_vpcConfiguration :: Lens' AddApplicationVpcConfiguration VpcConfiguration Source #
Description of the VPC to add to the application.
Destructuring the Response
data AddApplicationVpcConfigurationResponse Source #
See: newAddApplicationVpcConfigurationResponse smart constructor.
Constructors
| AddApplicationVpcConfigurationResponse' | |
Fields
| |
Instances
newAddApplicationVpcConfigurationResponse Source #
Arguments
| :: Int | |
| -> AddApplicationVpcConfigurationResponse |
Create a value of AddApplicationVpcConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationARN:AddApplicationVpcConfigurationResponse', addApplicationVpcConfigurationResponse_applicationARN - The ARN of the application.
$sel:applicationVersionId:AddApplicationVpcConfigurationResponse', addApplicationVpcConfigurationResponse_applicationVersionId - Provides the current application version. Kinesis Data Analytics updates
the ApplicationVersionId each time you update the application.
$sel:vpcConfigurationDescription:AddApplicationVpcConfigurationResponse', addApplicationVpcConfigurationResponse_vpcConfigurationDescription - The parameters of the new VPC configuration.
$sel:httpStatus:AddApplicationVpcConfigurationResponse', addApplicationVpcConfigurationResponse_httpStatus - The response's http status code.
Response Lenses
addApplicationVpcConfigurationResponse_applicationARN :: Lens' AddApplicationVpcConfigurationResponse (Maybe Text) Source #
The ARN of the application.
addApplicationVpcConfigurationResponse_applicationVersionId :: Lens' AddApplicationVpcConfigurationResponse (Maybe Natural) Source #
Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.
addApplicationVpcConfigurationResponse_vpcConfigurationDescription :: Lens' AddApplicationVpcConfigurationResponse (Maybe VpcConfigurationDescription) Source #
The parameters of the new VPC configuration.
addApplicationVpcConfigurationResponse_httpStatus :: Lens' AddApplicationVpcConfigurationResponse Int Source #
The response's http status code.