You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SecurityHub::Types::AwsApiGatewayStageDetails

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing AwsApiGatewayStageDetails as input to an Aws::Client method, you can use a vanilla 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",
}

Provides information about a version 1 Amazon API Gateway stage.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#access_log_settings ⇒ Types::AwsApiGatewayAccessLogSettings

Settings for logging access for the stage.

Returns:

#cache_cluster_enabled ⇒ Boolean

Indicates whether a cache cluster is enabled for the stage.

Returns:

  • (Boolean) —

    Indicates whether a cache cluster is enabled for the stage.

#cache_cluster_size ⇒ String

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

Returns:

  • (String) —

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

#cache_cluster_status ⇒ String

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

Returns:

  • (String) —

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

#canary_settings ⇒ Types::AwsApiGatewayCanarySettings

Information about settings for canary deployment in the stage.

Returns:

#client_certificate_id ⇒ String

The identifier of the client certificate for the stage.

Returns:

  • (String) —

    The identifier of the client certificate for the stage.

#created_date ⇒ String

Indicates when the stage was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Returns:

  • (String) —

    Indicates when the stage was created.

#deployment_id ⇒ String

The identifier of the deployment that the stage points to.

Returns:

  • (String) —

    The identifier of the deployment that the stage points to.

#description ⇒ String

A description of the stage.

Returns:

  • (String) —

    A description of the stage.

#documentation_version ⇒ String

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

Returns:

  • (String) —

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

#last_updated_date ⇒ String

Indicates when the stage was most recently updated.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Returns:

  • (String) —

    Indicates when the stage was most recently updated.

#method_settings ⇒ Array<Types::AwsApiGatewayMethodSettings>

Defines the method settings for the stage.

Returns:

#stage_name ⇒ String

The name of the stage.

Returns:

  • (String) —

    The name of the stage.

#tracing_enabled ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#variables ⇒ Hash<String,String>

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 -._~:/?#&=,

Returns:

  • (Hash<String,String>) —

    A map that defines the stage variables for the stage.

#web_acl_arn ⇒ String

The ARN of the web ACL associated with the stage.

Returns:

  • (String) —

    The ARN of the web ACL associated with the stage.