software.amazon.awscdk.services.apigateway

Interface CfnDeploymentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeploymentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.14.1 (build 828de8a)",
           date="2020-11-24T22:28:02.311Z")
 @Stability(value=Stable)
public interface CfnDeploymentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::ApiGateway::Deployment`.

See Also:

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

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 Object	getDeploymentCanarySettings() `AWS::ApiGateway::Deployment.DeploymentCanarySettings`.
default String	getDescription() `AWS::ApiGateway::Deployment.Description`.
String	getRestApiId() `AWS::ApiGateway::Deployment.RestApiId`.
default Object	getStageDescription() `AWS::ApiGateway::Deployment.StageDescription`.
default String	getStageName() `AWS::ApiGateway::Deployment.StageName`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getRestApiId

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

`AWS::ApiGateway::Deployment.RestApiId`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-restapiid

getDeploymentCanarySettings

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

`AWS::ApiGateway::Deployment.DeploymentCanarySettings`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-deploymentcanarysettings

getDescription

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

`AWS::ApiGateway::Deployment.Description`.

See Also:

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

getStageDescription

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

`AWS::ApiGateway::Deployment.StageDescription`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagedescription

getStageName

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

`AWS::ApiGateway::Deployment.StageName`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagename

builder

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

Returns:

a CfnDeploymentProps.Builder of CfnDeploymentProps