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

Class: Aws::SecurityHub::Types::AwsApiGatewayV2StageDetails

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

Overview

Note:

When passing AwsApiGatewayV2StageDetails as input to an Aws::Client method, you can use a vanilla Hash:

{
  created_date: "NonEmptyString",
  description: "NonEmptyString",
  default_route_settings: {
    detailed_metrics_enabled: false,
    logging_level: "NonEmptyString",
    data_trace_enabled: false,
    throttling_burst_limit: 1,
    throttling_rate_limit: 1.0,
  },
  deployment_id: "NonEmptyString",
  last_updated_date: "NonEmptyString",
  route_settings: {
    detailed_metrics_enabled: false,
    logging_level: "NonEmptyString",
    data_trace_enabled: false,
    throttling_burst_limit: 1,
    throttling_rate_limit: 1.0,
  },
  stage_name: "NonEmptyString",
  stage_variables: {
    "NonEmptyString" => "NonEmptyString",
  },
  access_log_settings: {
    format: "NonEmptyString",
    destination_arn: "NonEmptyString",
  },
  auto_deploy: false,
  last_deployment_status_message: "NonEmptyString",
  api_gateway_managed: false,
}

Contains information about a version 2 stage for Amazon API Gateway.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#access_log_settings ⇒ Types::AwsApiGatewayAccessLogSettings

Information about settings for logging access for the stage.

Returns:

#api_gateway_managed ⇒ Boolean

Indicates whether the stage is managed by API Gateway.

Returns:

  • (Boolean) —

    Indicates whether the stage is managed by API Gateway.

#auto_deploy ⇒ Boolean

Indicates whether updates to an API automatically trigger a new deployment.

Returns:

  • (Boolean) —

    Indicates whether updates to an API automatically trigger a new deployment.

#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.

#default_route_settings ⇒ Types::AwsApiGatewayV2RouteSettings

Default route settings for the stage.

Returns:

#deployment_id ⇒ String

The identifier of the deployment that the stage is associated with.

Returns:

  • (String) —

    The identifier of the deployment that the stage is associated with.

#description ⇒ String

The description of the stage.

Returns:

  • (String) —

    The description of the stage.

#last_deployment_status_message ⇒ String

The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.

Returns:

  • (String) —

    The status of the last deployment of a 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.

#route_settings ⇒ Types::AwsApiGatewayV2RouteSettings

The route settings for the stage.

Returns:

#stage_name ⇒ String

The name of the stage.

Returns:

  • (String) —

    The name of the stage.

#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.