Package software.amazon.awscdk.services.apigateway

Class CfnDeployment

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.apigateway.CfnDeployment
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:44.760Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDeployment

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

    • CfnDeployment

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

    • CfnDeployment

      @Stability(Stable) public CfnDeployment(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrDeploymentId()
      The ID for the deployment.

      For example: abc123 .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getRestApiId

      @Stability(Stable) @NotNull public String getRestApiId()
      The string identifier of the associated RestApi.

    • setRestApiId

      @Stability(Stable) public void setRestApiId(@NotNull String value)
      The string identifier of the associated RestApi.

    • getDeploymentCanarySettings

      @Stability(Stable) @Nullable public Object getDeploymentCanarySettings()
      The input configuration for a canary deployment.

    • setDeploymentCanarySettings

      @Stability(Stable) public void setDeploymentCanarySettings(@Nullable IResolvable value)
      The input configuration for a canary deployment.

    • setDeploymentCanarySettings

      @Stability(Stable) public void setDeploymentCanarySettings(@Nullable CfnDeployment.DeploymentCanarySettingsProperty value)
      The input configuration for a canary deployment.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description for the Deployment resource to create.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description for the Deployment resource to create.

    • getStageDescription

      @Stability(Stable) @Nullable public Object getStageDescription()
      The description of the Stage resource for the Deployment resource to create.

      To specify a stage description, you must also provide a stage name.

    • setStageDescription

      @Stability(Stable) public void setStageDescription(@Nullable IResolvable value)
      The description of the Stage resource for the Deployment resource to create.

      To specify a stage description, you must also provide a stage name.

    • setStageDescription

      @Stability(Stable) public void setStageDescription(@Nullable CfnDeployment.StageDescriptionProperty value)
      The description of the Stage resource for the Deployment resource to create.

      To specify a stage description, you must also provide a stage name.

    • getStageName

      @Stability(Stable) @Nullable public String getStageName()
      The name of the Stage resource for the Deployment resource to create.

    • setStageName

      @Stability(Stable) public void setStageName(@Nullable String value)
      The name of the Stage resource for the Deployment resource to create.