class Aws::SecurityHub::Types::AwsApiGatewayStageDetails
Provides information about a version 1 Amazon API Gateway stage.
@note When making an API call, you may pass AwsApiGatewayStageDetails
data as a hash: { deployment_id: "NonEmptyString", client_certificate_id: "NonEmptyString", stage_name: "NonEmptyString", description: "NonEmptyString", cache_cluster_enabled: false, cache_cluster_size: "NonEmptyString", cache_cluster_status: "NonEmptyString", method_settings: [ { metrics_enabled: false, logging_level: "NonEmptyString", data_trace_enabled: false, throttling_burst_limit: 1, throttling_rate_limit: 1.0, caching_enabled: false, cache_ttl_in_seconds: 1, cache_data_encrypted: false, require_authorization_for_cache_control: false, unauthorized_cache_control_header_strategy: "NonEmptyString", http_method: "NonEmptyString", resource_path: "NonEmptyString", }, ], variables: { "NonEmptyString" => "NonEmptyString", }, documentation_version: "NonEmptyString", access_log_settings: { format: "NonEmptyString", destination_arn: "NonEmptyString", }, canary_settings: { percent_traffic: 1.0, deployment_id: "NonEmptyString", stage_variable_overrides: { "NonEmptyString" => "NonEmptyString", }, use_stage_cache: false, }, tracing_enabled: false, created_date: "NonEmptyString", last_updated_date: "NonEmptyString", web_acl_arn: "NonEmptyString", }
@!attribute [rw] deployment_id
The identifier of the deployment that the stage points to. @return [String]
@!attribute [rw] client_certificate_id
The identifier of the client certificate for the stage. @return [String]
@!attribute [rw] stage_name
The name of the stage. @return [String]
@!attribute [rw] description
A description of the stage. @return [String]
@!attribute [rw] cache_cluster_enabled
Indicates whether a cache cluster is enabled for the stage. @return [Boolean]
@!attribute [rw] cache_cluster_size
If a cache cluster is enabled, the size of the cache cluster. @return [String]
@!attribute [rw] cache_cluster_status
If a cache cluster is enabled, the status of the cache cluster. @return [String]
@!attribute [rw] method_settings
Defines the method settings for the stage. @return [Array<Types::AwsApiGatewayMethodSettings>]
@!attribute [rw] 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 -.\_~:/?#&=, @return [Hash<String,String>]
@!attribute [rw] documentation_version
The version of the API documentation that is associated with the stage. @return [String]
@!attribute [rw] access_log_settings
Settings for logging access for the stage. @return [Types::AwsApiGatewayAccessLogSettings]
@!attribute [rw] canary_settings
Information about settings for canary deployment in the stage. @return [Types::AwsApiGatewayCanarySettings]
@!attribute [rw] tracing_enabled
Indicates whether active tracing with X-Ray is enabled for the stage. @return [Boolean]
@!attribute [rw] created_date
Indicates when the stage was created. Uses the `date-time` format specified in [RFC 3339 section 5.6, Internet Date/Time Format][1]. The value cannot contain spaces. For example, `2020-03-22T13:22:13.933Z`. [1]: https://tools.ietf.org/html/rfc3339#section-5.6 @return [String]
@!attribute [rw] last_updated_date
Indicates when the stage was most recently updated. Uses the `date-time` format specified in [RFC 3339 section 5.6, Internet Date/Time Format][1]. The value cannot contain spaces. For example, `2020-03-22T13:22:13.933Z`. [1]: https://tools.ietf.org/html/rfc3339#section-5.6 @return [String]
@!attribute [rw] web_acl_arn
The ARN of the web ACL associated with the stage. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/AwsApiGatewayStageDetails AWS API Documentation
Constants
- SENSITIVE