software.amazon.awscdk.services.apigateway

Interface CfnStageProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStageProps.Jsii$Proxy

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

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

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnStageProps.Builder A builder for CfnStageProps
static class	CfnStageProps.Jsii$Proxy An implementation for CfnStageProps

Method Summary

Modifier and Type	Method and Description
static CfnStageProps.Builder	builder()
default Object	getAccessLogSetting() `AWS::ApiGateway::Stage.AccessLogSetting`.
default Object	getCacheClusterEnabled() `AWS::ApiGateway::Stage.CacheClusterEnabled`.
default String	getCacheClusterSize() `AWS::ApiGateway::Stage.CacheClusterSize`.
default Object	getCanarySetting() `AWS::ApiGateway::Stage.CanarySetting`.
default String	getClientCertificateId() `AWS::ApiGateway::Stage.ClientCertificateId`.
default String	getDeploymentId() `AWS::ApiGateway::Stage.DeploymentId`.
default String	getDescription() `AWS::ApiGateway::Stage.Description`.
default String	getDocumentationVersion() `AWS::ApiGateway::Stage.DocumentationVersion`.
default Object	getMethodSettings() `AWS::ApiGateway::Stage.MethodSettings`.
String	getRestApiId() `AWS::ApiGateway::Stage.RestApiId`.
default String	getStageName() `AWS::ApiGateway::Stage.StageName`.
default List<CfnTag>	getTags() `AWS::ApiGateway::Stage.Tags`.
default Object	getTracingEnabled() `AWS::ApiGateway::Stage.TracingEnabled`.
default Object	getVariables() `AWS::ApiGateway::Stage.Variables`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getRestApiId

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

`AWS::ApiGateway::Stage.RestApiId`.

See Also:

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

getAccessLogSetting

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

`AWS::ApiGateway::Stage.AccessLogSetting`.

See Also:

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

getCacheClusterEnabled

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

`AWS::ApiGateway::Stage.CacheClusterEnabled`.

See Also:

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

getCacheClusterSize

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

`AWS::ApiGateway::Stage.CacheClusterSize`.

See Also:

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

getCanarySetting

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

`AWS::ApiGateway::Stage.CanarySetting`.

See Also:

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

getClientCertificateId

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

`AWS::ApiGateway::Stage.ClientCertificateId`.

See Also:

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

getDeploymentId

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

`AWS::ApiGateway::Stage.DeploymentId`.

See Also:

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

getDescription

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

`AWS::ApiGateway::Stage.Description`.

See Also:

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

getDocumentationVersion

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

`AWS::ApiGateway::Stage.DocumentationVersion`.

See Also:

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

getMethodSettings

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

`AWS::ApiGateway::Stage.MethodSettings`.

See Also:

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

getStageName

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

`AWS::ApiGateway::Stage.StageName`.

See Also:

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

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::ApiGateway::Stage.Tags`.

See Also:

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

getTracingEnabled

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

`AWS::ApiGateway::Stage.TracingEnabled`.

See Also:

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

getVariables

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

`AWS::ApiGateway::Stage.Variables`.

See Also:

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

builder

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

Returns:

a CfnStageProps.Builder of CfnStageProps