Class: Aws::SecurityHub::Types::AwsApiGatewayMethodSettings

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 AwsApiGatewayMethodSettings data as a hash:

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

Defines settings for a method for the stage.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cache_data_encryptedBoolean

Indicates whether the cached responses are encrypted.

Returns:

  • (Boolean)


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 816

class AwsApiGatewayMethodSettings < Struct.new(
  :metrics_enabled,
  :logging_level,
  :data_trace_enabled,
  :throttling_burst_limit,
  :throttling_rate_limit,
  :caching_enabled,
  :cache_ttl_in_seconds,
  :cache_data_encrypted,
  :require_authorization_for_cache_control,
  :unauthorized_cache_control_header_strategy,
  :http_method,
  :resource_path)
  SENSITIVE = []
  include Aws::Structure
end

#cache_ttl_in_secondsInteger

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response is cached.

Returns:

  • (Integer)


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 816

class AwsApiGatewayMethodSettings < Struct.new(
  :metrics_enabled,
  :logging_level,
  :data_trace_enabled,
  :throttling_burst_limit,
  :throttling_rate_limit,
  :caching_enabled,
  :cache_ttl_in_seconds,
  :cache_data_encrypted,
  :require_authorization_for_cache_control,
  :unauthorized_cache_control_header_strategy,
  :http_method,
  :resource_path)
  SENSITIVE = []
  include Aws::Structure
end

#caching_enabledBoolean

Indicates whether responses are cached and returned for requests. For responses to be cached, a cache cluster must be enabled on the stage.

Returns:

  • (Boolean)


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 816

class AwsApiGatewayMethodSettings < Struct.new(
  :metrics_enabled,
  :logging_level,
  :data_trace_enabled,
  :throttling_burst_limit,
  :throttling_rate_limit,
  :caching_enabled,
  :cache_ttl_in_seconds,
  :cache_data_encrypted,
  :require_authorization_for_cache_control,
  :unauthorized_cache_control_header_strategy,
  :http_method,
  :resource_path)
  SENSITIVE = []
  include Aws::Structure
end

#data_trace_enabledBoolean

Indicates whether data trace logging is enabled for the method. Data trace logging affects the log entries that are pushed to CloudWatch Logs.

Returns:

  • (Boolean)


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 816

class AwsApiGatewayMethodSettings < Struct.new(
  :metrics_enabled,
  :logging_level,
  :data_trace_enabled,
  :throttling_burst_limit,
  :throttling_rate_limit,
  :caching_enabled,
  :cache_ttl_in_seconds,
  :cache_data_encrypted,
  :require_authorization_for_cache_control,
  :unauthorized_cache_control_header_strategy,
  :http_method,
  :resource_path)
  SENSITIVE = []
  include Aws::Structure
end

#http_methodString

The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

Returns:

  • (String)


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 816

class AwsApiGatewayMethodSettings < Struct.new(
  :metrics_enabled,
  :logging_level,
  :data_trace_enabled,
  :throttling_burst_limit,
  :throttling_rate_limit,
  :caching_enabled,
  :cache_ttl_in_seconds,
  :cache_data_encrypted,
  :require_authorization_for_cache_control,
  :unauthorized_cache_control_header_strategy,
  :http_method,
  :resource_path)
  SENSITIVE = []
  include Aws::Structure
end

#logging_levelString

The logging level for this method. The logging level affects the log entries that are pushed to CloudWatch Logs.

If the logging level is ERROR, then the logs only include error-level entries.

If the logging level is INFO, then the logs include both ERROR events and extra informational events.

Valid values: OFF | ERROR | INFO

Returns:

  • (String)


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 816

class AwsApiGatewayMethodSettings < Struct.new(
  :metrics_enabled,
  :logging_level,
  :data_trace_enabled,
  :throttling_burst_limit,
  :throttling_rate_limit,
  :caching_enabled,
  :cache_ttl_in_seconds,
  :cache_data_encrypted,
  :require_authorization_for_cache_control,
  :unauthorized_cache_control_header_strategy,
  :http_method,
  :resource_path)
  SENSITIVE = []
  include Aws::Structure
end

#metrics_enabledBoolean

Indicates whether CloudWatch metrics are enabled for the method.

Returns:

  • (Boolean)


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 816

class AwsApiGatewayMethodSettings < Struct.new(
  :metrics_enabled,
  :logging_level,
  :data_trace_enabled,
  :throttling_burst_limit,
  :throttling_rate_limit,
  :caching_enabled,
  :cache_ttl_in_seconds,
  :cache_data_encrypted,
  :require_authorization_for_cache_control,
  :unauthorized_cache_control_header_strategy,
  :http_method,
  :resource_path)
  SENSITIVE = []
  include Aws::Structure
end

#require_authorization_for_cache_controlBoolean

Indicates whether authorization is required for a cache invalidation request.

Returns:

  • (Boolean)


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 816

class AwsApiGatewayMethodSettings < Struct.new(
  :metrics_enabled,
  :logging_level,
  :data_trace_enabled,
  :throttling_burst_limit,
  :throttling_rate_limit,
  :caching_enabled,
  :cache_ttl_in_seconds,
  :cache_data_encrypted,
  :require_authorization_for_cache_control,
  :unauthorized_cache_control_header_strategy,
  :http_method,
  :resource_path)
  SENSITIVE = []
  include Aws::Structure
end

#resource_pathString

The resource path for this method. Forward slashes (/) are encoded as ~1 . The initial slash must include a forward slash.

For example, the path value /resource/subresource must be encoded as /~1resource~1subresource.

To specify the root path, use only a slash (/). You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

Returns:

  • (String)


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 816

class AwsApiGatewayMethodSettings < Struct.new(
  :metrics_enabled,
  :logging_level,
  :data_trace_enabled,
  :throttling_burst_limit,
  :throttling_rate_limit,
  :caching_enabled,
  :cache_ttl_in_seconds,
  :cache_data_encrypted,
  :require_authorization_for_cache_control,
  :unauthorized_cache_control_header_strategy,
  :http_method,
  :resource_path)
  SENSITIVE = []
  include Aws::Structure
end

#throttling_burst_limitInteger

The throttling burst limit for the method.

Returns:

  • (Integer)


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 816

class AwsApiGatewayMethodSettings < Struct.new(
  :metrics_enabled,
  :logging_level,
  :data_trace_enabled,
  :throttling_burst_limit,
  :throttling_rate_limit,
  :caching_enabled,
  :cache_ttl_in_seconds,
  :cache_data_encrypted,
  :require_authorization_for_cache_control,
  :unauthorized_cache_control_header_strategy,
  :http_method,
  :resource_path)
  SENSITIVE = []
  include Aws::Structure
end

#throttling_rate_limitFloat

The throttling rate limit for the method.

Returns:

  • (Float)


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 816

class AwsApiGatewayMethodSettings < Struct.new(
  :metrics_enabled,
  :logging_level,
  :data_trace_enabled,
  :throttling_burst_limit,
  :throttling_rate_limit,
  :caching_enabled,
  :cache_ttl_in_seconds,
  :cache_data_encrypted,
  :require_authorization_for_cache_control,
  :unauthorized_cache_control_header_strategy,
  :http_method,
  :resource_path)
  SENSITIVE = []
  include Aws::Structure
end

#unauthorized_cache_control_header_strategyString

Indicates how to handle unauthorized requests for cache invalidation.

Valid values: FAIL_WITH_403 | SUCCEED_WITH_RESPONSE_HEADER | SUCCEED_WITHOUT_RESPONSE_HEADER

Returns:

  • (String)


816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 816

class AwsApiGatewayMethodSettings < Struct.new(
  :metrics_enabled,
  :logging_level,
  :data_trace_enabled,
  :throttling_burst_limit,
  :throttling_rate_limit,
  :caching_enabled,
  :cache_ttl_in_seconds,
  :cache_data_encrypted,
  :require_authorization_for_cache_control,
  :unauthorized_cache_control_header_strategy,
  :http_method,
  :resource_path)
  SENSITIVE = []
  include Aws::Structure
end