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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb

Overview

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",
}

Provides information about a version 1 Amazon API Gateway stage.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_log_settingsTypes::AwsApiGatewayAccessLogSettings

Settings for logging access for the stage.



1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1038

class AwsApiGatewayStageDetails < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :created_date,
  :last_updated_date,
  :web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#cache_cluster_enabledBoolean

Indicates whether a cache cluster is enabled for the stage.

Returns:

  • (Boolean)


1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1038

class AwsApiGatewayStageDetails < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :created_date,
  :last_updated_date,
  :web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#cache_cluster_sizeString

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

Returns:

  • (String)


1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1038

class AwsApiGatewayStageDetails < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :created_date,
  :last_updated_date,
  :web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#cache_cluster_statusString

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

Returns:

  • (String)


1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1038

class AwsApiGatewayStageDetails < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :created_date,
  :last_updated_date,
  :web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#canary_settingsTypes::AwsApiGatewayCanarySettings

Information about settings for canary deployment in the stage.



1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1038

class AwsApiGatewayStageDetails < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :created_date,
  :last_updated_date,
  :web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#client_certificate_idString

The identifier of the client certificate for the stage.

Returns:

  • (String)


1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1038

class AwsApiGatewayStageDetails < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :created_date,
  :last_updated_date,
  :web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#created_dateString

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)


1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1038

class AwsApiGatewayStageDetails < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :created_date,
  :last_updated_date,
  :web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_idString

The identifier of the deployment that the stage points to.

Returns:

  • (String)


1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1038

class AwsApiGatewayStageDetails < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :created_date,
  :last_updated_date,
  :web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description of the stage.

Returns:

  • (String)


1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1038

class AwsApiGatewayStageDetails < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :created_date,
  :last_updated_date,
  :web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#documentation_versionString

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

Returns:

  • (String)


1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1038

class AwsApiGatewayStageDetails < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :created_date,
  :last_updated_date,
  :web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_dateString

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)


1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1038

class AwsApiGatewayStageDetails < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :created_date,
  :last_updated_date,
  :web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#method_settingsArray<Types::AwsApiGatewayMethodSettings>

Defines the method settings for the stage.



1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1038

class AwsApiGatewayStageDetails < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :created_date,
  :last_updated_date,
  :web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#stage_nameString

The name of the stage.

Returns:

  • (String)


1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1038

class AwsApiGatewayStageDetails < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :created_date,
  :last_updated_date,
  :web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#tracing_enabledBoolean

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

Returns:

  • (Boolean)


1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1038

class AwsApiGatewayStageDetails < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :created_date,
  :last_updated_date,
  :web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#variablesHash<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>)


1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1038

class AwsApiGatewayStageDetails < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :created_date,
  :last_updated_date,
  :web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#web_acl_arnString

The ARN of the web ACL associated with the stage.

Returns:

  • (String)


1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1038

class AwsApiGatewayStageDetails < Struct.new(
  :deployment_id,
  :client_certificate_id,
  :stage_name,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :cache_cluster_status,
  :method_settings,
  :variables,
  :documentation_version,
  :access_log_settings,
  :canary_settings,
  :tracing_enabled,
  :created_date,
  :last_updated_date,
  :web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end