Package software.amazon.awscdk.services.apigateway

Class CfnStageProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigateway.CfnStageProps.Jsii$Proxy

All Implemented Interfaces:

CfnStageProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnStageProps

@Stability(Stable)
@Internal
public static final class CfnStageProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnStageProps

An implementation for CfnStageProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.CfnStageProps

CfnStageProps.Builder, CfnStageProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnStageProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnStageProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getAccessLogSetting()	Access log settings, including the access log format and access log destination ARN.
final Object	getCacheClusterEnabled()	Specifies whether a cache cluster is enabled for the stage.
final String	getCacheClusterSize()	The stage's cache capacity in GB.
final Object	getCanarySetting()	Settings for the canary deployment in this stage.
final Object	getClientCertificateId()	The identifier of a client certificate for an API stage.
final Object	getDeploymentId()	The identifier of the Deployment that the stage points to.
final String	getDescription()	The stage's description.
final String	getDocumentationVersion()	The version of the associated API documentation.
final Object	getMethodSettings()	A map that defines the method settings for a Stage resource.
final Object	getRestApiId()	The string identifier of the associated RestApi.
final String	getStageName()	The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.
final List<CfnTag>	getTags()	The collection of tags.
final Object	getTracingEnabled()	Specifies whether active tracing with X-ray is enabled for the Stage.
final Object	getVariables()	A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnStageProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnStageProps.Builder.

Method Details

getRestApiId

public final Object getRestApiId()

Description copied from interface: CfnStageProps

The string identifier of the associated RestApi.

Returns union: either String or IRestApiRef

Specified by:

getRestApiId in interface CfnStageProps

See Also:

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

getAccessLogSetting

public final Object getAccessLogSetting()

Description copied from interface: CfnStageProps

Access log settings, including the access log format and access log destination ARN.

Returns union: either IResolvable or CfnStage.AccessLogSettingProperty

Specified by:

getAccessLogSetting in interface CfnStageProps

See Also:

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

getCacheClusterEnabled

public final Object getCacheClusterEnabled()

Description copied from interface: CfnStageProps

Specifies whether a cache cluster is enabled for the stage.

To activate a method-level cache, set CachingEnabled to true for a method.

Returns union: either Boolean or IResolvable

Specified by:

getCacheClusterEnabled in interface CfnStageProps

See Also:

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

getCacheClusterSize

public final String getCacheClusterSize()

Description copied from interface: CfnStageProps

The stage's cache capacity in GB.

For more information about choosing a cache size, see Enabling API caching to enhance responsiveness .

Specified by:

getCacheClusterSize in interface CfnStageProps

See Also:

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

getCanarySetting

public final Object getCanarySetting()

Description copied from interface: CfnStageProps

Settings for the canary deployment in this stage.

Returns union: either IResolvable or CfnStage.CanarySettingProperty

Specified by:

getCanarySetting in interface CfnStageProps

See Also:

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

getClientCertificateId

public final Object getClientCertificateId()

Description copied from interface: CfnStageProps

The identifier of a client certificate for an API stage.

Returns union: either String or IClientCertificateRef

Specified by:

getClientCertificateId in interface CfnStageProps

See Also:

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

getDeploymentId

public final Object getDeploymentId()

Description copied from interface: CfnStageProps

The identifier of the Deployment that the stage points to.

Returns union: either String or IDeploymentRef

Specified by:

getDeploymentId in interface CfnStageProps

See Also:

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

getDescription

public final String getDescription()

Description copied from interface: CfnStageProps

The stage's description.

Specified by:

getDescription in interface CfnStageProps

See Also:

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

getDocumentationVersion

public final String getDocumentationVersion()

Description copied from interface: CfnStageProps

The version of the associated API documentation.

Specified by:

getDocumentationVersion in interface CfnStageProps

See Also:

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

getMethodSettings

public final Object getMethodSettings()

Description copied from interface: CfnStageProps

A map that defines the method settings for a Stage resource.

Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\* /\* for overriding all methods in the stage.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnStage.MethodSettingProperty>

Specified by:

getMethodSettings in interface CfnStageProps

See Also:

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

getStageName

public final String getStageName()

Description copied from interface: CfnStageProps

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.

Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Specified by:

getStageName in interface CfnStageProps

See Also:

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

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnStageProps

The collection of tags.

Each tag element is associated with a given resource.

Specified by:

getTags in interface CfnStageProps

See Also:

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

getTracingEnabled

public final Object getTracingEnabled()

Description copied from interface: CfnStageProps

Specifies whether active tracing with X-ray is enabled for the Stage.

Returns union: either Boolean or IResolvable

Specified by:

getTracingEnabled in interface CfnStageProps

See Also:

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

getVariables

public final Object getVariables()

Description copied from interface: CfnStageProps

A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value.

Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+ .

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

Specified by:

getVariables in interface CfnStageProps

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object