AwsApiGatewayStageDetails - Amazon Security Hub
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AwsApiGatewayStageDetails

Provides information about a version 1 Amazon API Gateway stage.

Contents

AccessLogSettings

Settings for logging access for the stage.

Type: AwsApiGatewayAccessLogSettings object

Required: No

CacheClusterEnabled

Indicates whether a cache cluster is enabled for the stage.

Type: Boolean

Required: No

CacheClusterSize

If a cache cluster is enabled, the size of the cache cluster.

Type: String

Pattern: .*\S.*

Required: No

CacheClusterStatus

If a cache cluster is enabled, the status of the cache cluster.

Type: String

Pattern: .*\S.*

Required: No

CanarySettings

Information about settings for canary deployment in the stage.

Type: AwsApiGatewayCanarySettings object

Required: No

ClientCertificateId

The identifier of the client certificate for the stage.

Type: String

Pattern: .*\S.*

Required: No

CreatedDate

Indicates when the stage was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

Type: String

Pattern: .*\S.*

Required: No

DeploymentId

The identifier of the deployment that the stage points to.

Type: String

Pattern: .*\S.*

Required: No

Description

A description of the stage.

Type: String

Pattern: .*\S.*

Required: No

DocumentationVersion

The version of the API documentation that is associated with the stage.

Type: String

Pattern: .*\S.*

Required: No

LastUpdatedDate

Indicates when the stage was most recently updated.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

Type: String

Pattern: .*\S.*

Required: No

MethodSettings

Defines the method settings for the stage.

Type: Array of AwsApiGatewayMethodSettings objects

Required: No

StageName

The name of the stage.

Type: String

Pattern: .*\S.*

Required: No

TracingEnabled

Indicates whether active tracing with Amazon X-Ray is enabled for the stage.

Type: Boolean

Required: No

Variables

A map that defines the stage variables for the stage.

Variable names can have alphanumeric and underscore characters.

Variable values can contain the following characters:

  • Uppercase and lowercase letters

  • Numbers

  • Special characters -._~:/?#&=,

Type: String to string map

Key Pattern: .*\S.*

Value Pattern: .*\S.*

Required: No

WebAclArn

The ARN of the web ACL associated with the stage.

Type: String

Pattern: .*\S.*

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: