Class: Aws::SecurityHub::Types::AwsApiGatewayStageDetails
- Inherits:
-
Struct
- Object
- Struct
- Aws::SecurityHub::Types::AwsApiGatewayStageDetails
- Defined in:
- gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb
Overview
Provides information about a version 1 Amazon API Gateway stage.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#access_log_settings ⇒ Types::AwsApiGatewayAccessLogSettings
Settings for logging access for the stage.
-
#cache_cluster_enabled ⇒ 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.
-
#cache_cluster_status ⇒ 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.
-
#client_certificate_id ⇒ String
The identifier of the client certificate for the stage.
-
#created_date ⇒ String
Indicates when the stage was created.
-
#deployment_id ⇒ String
The identifier of the deployment that the stage points to.
-
#description ⇒ String
A description of the stage.
-
#documentation_version ⇒ 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.
-
#method_settings ⇒ Array<Types::AwsApiGatewayMethodSettings>
Defines the method settings for the stage.
-
#stage_name ⇒ String
The name of the stage.
-
#tracing_enabled ⇒ Boolean
Indicates whether active tracing with X-Ray is enabled for the stage.
-
#variables ⇒ 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.
Instance Attribute Details
#access_log_settings ⇒ Types::AwsApiGatewayAccessLogSettings
Settings for logging access for the stage.
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1839 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_enabled ⇒ Boolean
Indicates whether a cache cluster is enabled for the stage.
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1839 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_size ⇒ String
If a cache cluster is enabled, the size of the cache cluster.
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1839 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_status ⇒ String
If a cache cluster is enabled, the status of the cache cluster.
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1839 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_settings ⇒ Types::AwsApiGatewayCanarySettings
Information about settings for canary deployment in the stage.
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1839 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_id ⇒ String
The identifier of the client certificate for the stage.
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1839 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_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, and
date and time should be separated by T
. For example,
2020-03-22T13:22:13.933Z
.
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1839 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_id ⇒ String
The identifier of the deployment that the stage points to.
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1839 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 |
#description ⇒ String
A description of the stage.
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1839 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_version ⇒ String
The version of the API documentation that is associated with the stage.
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1839 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_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, and
date and time should be separated by T
. For example,
2020-03-22T13:22:13.933Z
.
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1839 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_settings ⇒ Array<Types::AwsApiGatewayMethodSettings>
Defines the method settings for the stage.
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1839 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_name ⇒ String
The name of the stage.
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1839 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_enabled ⇒ Boolean
Indicates whether active tracing with X-Ray is enabled for the stage.
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1839 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 |
#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 -._~:/?#&=,
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1839 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_arn ⇒ String
The ARN of the web ACL associated with the stage.
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1839 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 |