@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
date="2022-08-02T20:25:34.621Z")
public interface CfnDeploymentProps
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();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnDeploymentProps.Builder
A builder for
CfnDeploymentProps |
static class |
CfnDeploymentProps.Jsii$Proxy
An implementation for
CfnDeploymentProps |
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.
|
java.lang.String getRestApiId()
default java.lang.Object getDeploymentCanarySettings()
default java.lang.String getDescription()
default java.lang.Object getStageDescription()
default java.lang.String getStageName()
Use only alphanumeric characters.
static CfnDeploymentProps.Builder builder()
CfnDeploymentProps.Builder
of CfnDeploymentProps