Class: Aws::CloudWatchLogs::Types::ConfigurationTemplate

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchLogs::Types::ConfigurationTemplate

Defined in:

gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb

Overview

A structure containing information about the deafult settings and available settings that you can use to configure a delivery or a delivery destination.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allowed_action_for_allow_vended_logs_delivery_for_resource ⇒ String

  The action permissions that a caller needs to have to be able to successfully create a delivery source on the desired resource type when calling [PutDeliverySource][1].

• #allowed_field_delimiters ⇒ Array<String>

  The valid values that a caller can use as field delimiters when calling [CreateDelivery][1] or [UpdateDeliveryConfiguration][2] on a delivery that delivers in Plain, W3C, or Raw format.

• #allowed_fields ⇒ Array<Types::RecordField>

  The allowed fields that a caller can use in the recordFields parameter of a [CreateDelivery][1] or [UpdateDeliveryConfiguration][2] operation.

• #allowed_output_formats ⇒ Array<String>

  The list of delivery destination output formats that are supported by this log source.

• #allowed_suffix_path_fields ⇒ Array<String>

  The list of variable fields that can be used in the suffix path of a delivery that delivers to an S3 bucket.

• #default_delivery_config_values ⇒ Types::ConfigurationTemplateDeliveryConfigValues

  A mapping that displays the default value of each property within a delivery’s configuration, if it is not specified in the request.

• #delivery_destination_type ⇒ String

  A string specifying which destination type this configuration template applies to.

• #log_type ⇒ String

  A string specifying which log type this configuration template applies to.

• #resource_type ⇒ String

  A string specifying which resource type this configuration template applies to.

• #service ⇒ String

  A string specifying which service this configuration template applies to.

Instance Attribute Details

#allowed_action_for_allow_vended_logs_delivery_for_resource ⇒ String

The action permissions that a caller needs to have to be able to successfully create a delivery source on the desired resource type when calling PutDeliverySource.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 437

class ConfigurationTemplate < Struct.new(
  :service,
  :log_type,
  :resource_type,
  :delivery_destination_type,
  :default_delivery_config_values,
  :allowed_fields,
  :allowed_output_formats,
  :allowed_action_for_allow_vended_logs_delivery_for_resource,
  :allowed_field_delimiters,
  :allowed_suffix_path_fields)
  SENSITIVE = []
  include Aws::Structure
end

#allowed_field_delimiters ⇒ Array<String>

The valid values that a caller can use as field delimiters when calling CreateDelivery or UpdateDeliveryConfiguration on a delivery that delivers in Plain, W3C, or Raw format.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 437

class ConfigurationTemplate < Struct.new(
  :service,
  :log_type,
  :resource_type,
  :delivery_destination_type,
  :default_delivery_config_values,
  :allowed_fields,
  :allowed_output_formats,
  :allowed_action_for_allow_vended_logs_delivery_for_resource,
  :allowed_field_delimiters,
  :allowed_suffix_path_fields)
  SENSITIVE = []
  include Aws::Structure
end

#allowed_fields ⇒ Array<Types::RecordField>

The allowed fields that a caller can use in the recordFields parameter of a CreateDelivery or UpdateDeliveryConfiguration operation.

Returns:

• (Array<Types::RecordField>)

# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 437

class ConfigurationTemplate < Struct.new(
  :service,
  :log_type,
  :resource_type,
  :delivery_destination_type,
  :default_delivery_config_values,
  :allowed_fields,
  :allowed_output_formats,
  :allowed_action_for_allow_vended_logs_delivery_for_resource,
  :allowed_field_delimiters,
  :allowed_suffix_path_fields)
  SENSITIVE = []
  include Aws::Structure
end

#allowed_output_formats ⇒ Array<String>

The list of delivery destination output formats that are supported by this log source.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 437

class ConfigurationTemplate < Struct.new(
  :service,
  :log_type,
  :resource_type,
  :delivery_destination_type,
  :default_delivery_config_values,
  :allowed_fields,
  :allowed_output_formats,
  :allowed_action_for_allow_vended_logs_delivery_for_resource,
  :allowed_field_delimiters,
  :allowed_suffix_path_fields)
  SENSITIVE = []
  include Aws::Structure
end

#allowed_suffix_path_fields ⇒ Array<String>

The list of variable fields that can be used in the suffix path of a delivery that delivers to an S3 bucket.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 437

class ConfigurationTemplate < Struct.new(
  :service,
  :log_type,
  :resource_type,
  :delivery_destination_type,
  :default_delivery_config_values,
  :allowed_fields,
  :allowed_output_formats,
  :allowed_action_for_allow_vended_logs_delivery_for_resource,
  :allowed_field_delimiters,
  :allowed_suffix_path_fields)
  SENSITIVE = []
  include Aws::Structure
end

#default_delivery_config_values ⇒ Types::ConfigurationTemplateDeliveryConfigValues

A mapping that displays the default value of each property within a delivery’s configuration, if it is not specified in the request.

Returns:

• (Types::ConfigurationTemplateDeliveryConfigValues)

# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 437

class ConfigurationTemplate < Struct.new(
  :service,
  :log_type,
  :resource_type,
  :delivery_destination_type,
  :default_delivery_config_values,
  :allowed_fields,
  :allowed_output_formats,
  :allowed_action_for_allow_vended_logs_delivery_for_resource,
  :allowed_field_delimiters,
  :allowed_suffix_path_fields)
  SENSITIVE = []
  include Aws::Structure
end

#delivery_destination_type ⇒ String

A string specifying which destination type this configuration template applies to.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 437

class ConfigurationTemplate < Struct.new(
  :service,
  :log_type,
  :resource_type,
  :delivery_destination_type,
  :default_delivery_config_values,
  :allowed_fields,
  :allowed_output_formats,
  :allowed_action_for_allow_vended_logs_delivery_for_resource,
  :allowed_field_delimiters,
  :allowed_suffix_path_fields)
  SENSITIVE = []
  include Aws::Structure
end

#log_type ⇒ String

A string specifying which log type this configuration template applies to.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 437

class ConfigurationTemplate < Struct.new(
  :service,
  :log_type,
  :resource_type,
  :delivery_destination_type,
  :default_delivery_config_values,
  :allowed_fields,
  :allowed_output_formats,
  :allowed_action_for_allow_vended_logs_delivery_for_resource,
  :allowed_field_delimiters,
  :allowed_suffix_path_fields)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

A string specifying which resource type this configuration template applies to.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 437

class ConfigurationTemplate < Struct.new(
  :service,
  :log_type,
  :resource_type,
  :delivery_destination_type,
  :default_delivery_config_values,
  :allowed_fields,
  :allowed_output_formats,
  :allowed_action_for_allow_vended_logs_delivery_for_resource,
  :allowed_field_delimiters,
  :allowed_suffix_path_fields)
  SENSITIVE = []
  include Aws::Structure
end

#service ⇒ String

A string specifying which service this configuration template applies to. For more information about supported services see Enable logging from Amazon Web Services services..

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 437

class ConfigurationTemplate < Struct.new(
  :service,
  :log_type,
  :resource_type,
  :delivery_destination_type,
  :default_delivery_config_values,
  :allowed_fields,
  :allowed_output_formats,
  :allowed_action_for_allow_vended_logs_delivery_for_resource,
  :allowed_field_delimiters,
  :allowed_suffix_path_fields)
  SENSITIVE = []
  include Aws::Structure
end