software.amazon.awscdk.services.apigateway

Interface CfnDeploymentProps

All Known Implementing Classes:

CfnDeploymentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:45.187Z")
public interface CfnDeploymentProps

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.apigateway.*;
 CfnDeploymentProps cfnDeploymentProps = CfnDeploymentProps.builder()
         .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	Interface and Description
static class	CfnDeploymentProps.Builder A builder for CfnDeploymentProps
static class	CfnDeploymentProps.Jsii$Proxy An implementation for CfnDeploymentProps

Method Summary

Modifier and Type	Method and Description
static CfnDeploymentProps.Builder	builder()
default java.lang.Object	getDeploymentCanarySettings() Specifies settings for the canary deployment.
default java.lang.String	getDescription() A description of the purpose of the API Gateway deployment.
java.lang.String	getRestApiId() The ID of the `RestApi` resource to deploy.
default java.lang.Object	getStageDescription() Configures the stage that API Gateway creates with this deployment.
default java.lang.String	getStageName() A name for the stage that API Gateway creates with this deployment.

Method Detail

getRestApiId

java.lang.String getRestApiId()

The ID of the `RestApi` resource to deploy.

getDeploymentCanarySettings

default java.lang.Object getDeploymentCanarySettings()

Specifies settings for the canary deployment.

getDescription

default java.lang.String getDescription()

A description of the purpose of the API Gateway deployment.

getStageDescription

default java.lang.Object getStageDescription()

Configures the stage that API Gateway creates with this deployment.

getStageName

default java.lang.String getStageName()

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

Use only alphanumeric characters.

builder

static CfnDeploymentProps.Builder builder()

Returns:

a CfnDeploymentProps.Builder of CfnDeploymentProps