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

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

Overview

Provides information about a version 1 Amazon API Gateway stage.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_log_settings ⇒ Types::AwsApiGatewayAccessLogSettings

Settings for logging access for the stage.

Returns:



2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2002

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.

Returns:

  • (Boolean) 


2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2002

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.

Returns:

  • (String) 


2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2002

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.

Returns:

  • (String) 


2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2002

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.

Returns:



2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2002

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.

Returns:

  • (String) 


2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2002

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.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

Returns:

  • (String) 


2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2002

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.

Returns:

  • (String) 


2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2002

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.

Returns:

  • (String) 


2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2002

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.

Returns:

  • (String) 


2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2002

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.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

Returns:

  • (String) 


2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2002

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.

Returns:



2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2002

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.

Returns:

  • (String) 


2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2002

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.

Returns:

  • (Boolean) 


2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2002

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

Returns:

  • (Hash<String,String>) 


2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2002

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.

Returns:

  • (String) 


2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2002

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