software.amazon.awscdk.services.apigateway

Class CfnDeployment

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.apigateway.CfnDeployment

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.097Z")
 @Stability(value=Stable)
public class CfnDeployment
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ApiGateway::Deployment`.

The AWS::ApiGateway::Deployment resource deploys an API Gateway RestApi resource to a stage so that clients can call the API over the internet. The stage acts as an environment.

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.apigateway.*;
 CfnDeployment cfnDeployment = CfnDeployment.Builder.create(this, "MyCfnDeployment")
         .restApiId("restApiId")
         // the properties below are optional
         .deploymentCanarySettings(DeploymentCanarySettingsProperty.builder()
                 .percentTraffic(123)
                 .stageVariableOverrides(Map.of(
                         "stageVariableOverridesKey", "stageVariableOverrides"))
                 .useStageCache(false)
                 .build())
         .description("description")
         .stageDescription(StageDescriptionProperty.builder()
                 .accessLogSetting(AccessLogSettingProperty.builder()
                         .destinationArn("destinationArn")
                         .format("format")
                         .build())
                 .cacheClusterEnabled(false)
                 .cacheClusterSize("cacheClusterSize")
                 .cacheDataEncrypted(false)
                 .cacheTtlInSeconds(123)
                 .cachingEnabled(false)
                 .canarySetting(CanarySettingProperty.builder()
                         .percentTraffic(123)
                         .stageVariableOverrides(Map.of(
                                 "stageVariableOverridesKey", "stageVariableOverrides"))
                         .useStageCache(false)
                         .build())
                 .clientCertificateId("clientCertificateId")
                 .dataTraceEnabled(false)
                 .description("description")
                 .documentationVersion("documentationVersion")
                 .loggingLevel("loggingLevel")
                 .methodSettings(List.of(MethodSettingProperty.builder()
                         .cacheDataEncrypted(false)
                         .cacheTtlInSeconds(123)
                         .cachingEnabled(false)
                         .dataTraceEnabled(false)
                         .httpMethod("httpMethod")
                         .loggingLevel("loggingLevel")
                         .metricsEnabled(false)
                         .resourcePath("resourcePath")
                         .throttlingBurstLimit(123)
                         .throttlingRateLimit(123)
                         .build()))
                 .metricsEnabled(false)
                 .tags(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .throttlingBurstLimit(123)
                 .throttlingRateLimit(123)
                 .tracingEnabled(false)
                 .variables(Map.of(
                         "variablesKey", "variables"))
                 .build())
         .stageName("stageName")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnDeployment.AccessLogSettingProperty The `AccessLogSetting` property type specifies settings for logging access in this stage.
static class	CfnDeployment.Builder A fluent builder for CfnDeployment.
static interface	CfnDeployment.CanarySettingProperty The `CanarySetting` property type specifies settings for the canary deployment in this stage.
static interface	CfnDeployment.DeploymentCanarySettingsProperty The `DeploymentCanarySettings` property type specifies settings for the canary deployment.
static interface	CfnDeployment.MethodSettingProperty The `MethodSetting` property type configures settings for all methods in a stage.
static interface	CfnDeployment.StageDescriptionProperty `StageDescription` is a property of the [AWS::ApiGateway::Deployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html) resource that configures a deployment stage.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDeployment(software.constructs.Construct scope, String id, CfnDeploymentProps props) Create a new `AWS::ApiGateway::Deployment`.
protected	CfnDeployment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDeployment(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrDeploymentId() The ID for the deployment.
protected Map<String,Object>	getCfnProperties()
Object	getDeploymentCanarySettings() Specifies settings for the canary deployment.
String	getDescription() A description of the purpose of the API Gateway deployment.
String	getRestApiId() The ID of the `RestApi` resource to deploy.
Object	getStageDescription() Configures the stage that API Gateway creates with this deployment.
String	getStageName() A name for the stage that API Gateway creates with this deployment.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDeploymentCanarySettings(CfnDeployment.DeploymentCanarySettingsProperty value) Specifies settings for the canary deployment.
void	setDeploymentCanarySettings(IResolvable value) Specifies settings for the canary deployment.
void	setDescription(String value) A description of the purpose of the API Gateway deployment.
void	setRestApiId(String value) The ID of the `RestApi` resource to deploy.
void	setStageDescription(CfnDeployment.StageDescriptionProperty value) Configures the stage that API Gateway creates with this deployment.
void	setStageDescription(IResolvable value) Configures the stage that API Gateway creates with this deployment.
void	setStageName(String value) A name for the stage that API Gateway creates with this deployment.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDeployment

protected CfnDeployment(software.amazon.jsii.JsiiObjectRef objRef)

CfnDeployment

protected CfnDeployment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDeployment

@Stability(value=Stable)
public CfnDeployment(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              CfnDeploymentProps props)

Create a new `AWS::ApiGateway::Deployment`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDeploymentId

@Stability(value=Stable)
 @NotNull
public String getAttrDeploymentId()

The ID for the deployment.

For example: abc123 .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getRestApiId

@Stability(value=Stable)
 @NotNull
public String getRestApiId()

The ID of the `RestApi` resource to deploy.

setRestApiId

@Stability(value=Stable)
public void setRestApiId(@NotNull
                                                  String value)

The ID of the `RestApi` resource to deploy.

getDeploymentCanarySettings

@Stability(value=Stable)
 @Nullable
public Object getDeploymentCanarySettings()

Specifies settings for the canary deployment.

setDeploymentCanarySettings

@Stability(value=Stable)
public void setDeploymentCanarySettings(@Nullable
                                                                 CfnDeployment.DeploymentCanarySettingsProperty value)

Specifies settings for the canary deployment.

setDeploymentCanarySettings

@Stability(value=Stable)
public void setDeploymentCanarySettings(@Nullable
                                                                 IResolvable value)

Specifies settings for the canary deployment.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description of the purpose of the API Gateway deployment.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description of the purpose of the API Gateway deployment.

getStageDescription

@Stability(value=Stable)
 @Nullable
public Object getStageDescription()

Configures the stage that API Gateway creates with this deployment.

setStageDescription

@Stability(value=Stable)
public void setStageDescription(@Nullable
                                                         CfnDeployment.StageDescriptionProperty value)

Configures the stage that API Gateway creates with this deployment.

setStageDescription

@Stability(value=Stable)
public void setStageDescription(@Nullable
                                                         IResolvable value)

Configures the stage that API Gateway creates with this deployment.

getStageName

@Stability(value=Stable)
 @Nullable
public String getStageName()

A name for the stage that API Gateway creates with this deployment.

Use only alphanumeric characters.

setStageName

@Stability(value=Stable)
public void setStageName(@Nullable
                                                  String value)

A name for the stage that API Gateway creates with this deployment.

Use only alphanumeric characters.