Package software.amazon.awscdk.services.appconfig

Interface CfnDeploymentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeploymentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-11T23:26:28.244Z")
@Stability(Stable)
public interface CfnDeploymentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDeployment.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appconfig.*;
 CfnDeploymentProps cfnDeploymentProps = CfnDeploymentProps.builder()
         .applicationId("applicationId")
         .configurationProfileId("configurationProfileId")
         .configurationVersion("configurationVersion")
         .deploymentStrategyId("deploymentStrategyId")
         .environmentId("environmentId")
         // the properties below are optional
         .description("description")
         .dynamicExtensionParameters(List.of(DynamicExtensionParametersProperty.builder()
                 .extensionReference("extensionReference")
                 .parameterName("parameterName")
                 .parameterValue("parameterValue")
                 .build()))
         .kmsKeyIdentifier("kmsKeyIdentifier")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDeploymentProps.Builder	A builder for CfnDeploymentProps
static final class	CfnDeploymentProps.Jsii$Proxy	An implementation for CfnDeploymentProps

Method Summary

Modifier and Type	Method	Description
static CfnDeploymentProps.Builder	builder()
String	getApplicationId()	The application ID.
String	getConfigurationProfileId()	The configuration profile ID.
String	getConfigurationVersion()	The configuration version to deploy.
String	getDeploymentStrategyId()	The deployment strategy ID.
default String	getDescription()	A description of the deployment.
default Object	getDynamicExtensionParameters()	A map of dynamic extension parameter names to values to pass to associated extensions with PRE_START_DEPLOYMENT actions.
String	getEnvironmentId()	The environment ID.
default String	getKmsKeyIdentifier()	The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
default List<CfnTag>	getTags()	Metadata to assign to the deployment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplicationId

@Stability(Stable)
@NotNull
String getApplicationId()

The application ID.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-applicationid

getConfigurationProfileId

@Stability(Stable)
@NotNull
String getConfigurationProfileId()

The configuration profile ID.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-configurationprofileid

getConfigurationVersion

@Stability(Stable)
@NotNull
String getConfigurationVersion()

The configuration version to deploy.

If deploying an AWS AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-configurationversion

getDeploymentStrategyId

@Stability(Stable)
@NotNull
String getDeploymentStrategyId()

The deployment strategy ID.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-deploymentstrategyid

getEnvironmentId

@Stability(Stable)
@NotNull
String getEnvironmentId()

The environment ID.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-environmentid

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the deployment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-description

getDynamicExtensionParameters

@Stability(Stable)
@Nullable
default Object getDynamicExtensionParameters()

A map of dynamic extension parameter names to values to pass to associated extensions with PRE_START_DEPLOYMENT actions.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-dynamicextensionparameters

getKmsKeyIdentifier

@Stability(Stable)
@Nullable
default String getKmsKeyIdentifier()

The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-kmskeyidentifier

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Metadata to assign to the deployment.

Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-tags

builder

@Stability(Stable)
static CfnDeploymentProps.Builder builder()

Returns:

a CfnDeploymentProps.Builder of CfnDeploymentProps