Class: Aws::ConfigService::Types::DeliveryChannel

Inherits:

Struct

• Object
• Struct
• Aws::ConfigService::Types::DeliveryChannel

Includes:

Structure

Defined in:

lib/aws-sdk-configservice/types.rb

Overview

The channel through which Config delivers notifications and updated configuration states.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #config_snapshot_delivery_properties ⇒ Types::ConfigSnapshotDeliveryProperties

  The options for how often Config delivers configuration snapshots to the Amazon S3 bucket.

• #name ⇒ String

  The name of the delivery channel.

• #s3_bucket_name ⇒ String

  The name of the Amazon S3 bucket to which Config delivers configuration snapshots and configuration history files.

• #s3_key_prefix ⇒ String

  The prefix for the specified Amazon S3 bucket.

• #s3_kms_key_arn ⇒ String

  The Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key (KMS key) used to encrypt objects delivered by Config.

• #sns_topic_arn ⇒ String

  The Amazon Resource Name (ARN) of the Amazon SNS topic to which Config sends notifications about configuration changes.

Instance Attribute Details

#config_snapshot_delivery_properties ⇒ Types::ConfigSnapshotDeliveryProperties

The options for how often Config delivers configuration snapshots to the Amazon S3 bucket.

Returns:

• (Types::ConfigSnapshotDeliveryProperties)

# File 'lib/aws-sdk-configservice/types.rb', line 2656

class DeliveryChannel < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :s3_kms_key_arn,
  :sns_topic_arn,
  :config_snapshot_delivery_properties)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the delivery channel. By default, Config assigns the name “default” when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name.

Returns:

• (String)

# File 'lib/aws-sdk-configservice/types.rb', line 2656

class DeliveryChannel < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :s3_kms_key_arn,
  :sns_topic_arn,
  :config_snapshot_delivery_properties)
  SENSITIVE = []
  include Aws::Structure
end

#s3_bucket_name ⇒ String

The name of the Amazon S3 bucket to which Config delivers configuration snapshots and configuration history files.

If you specify a bucket that belongs to another Amazon Web Services account, that bucket must have policies that grant access permissions to Config. For more information, see [Permissions for the Amazon S3 Bucket] in the *Config Developer Guide*.

[1]: docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html

Returns:

• (String)

# File 'lib/aws-sdk-configservice/types.rb', line 2656

class DeliveryChannel < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :s3_kms_key_arn,
  :sns_topic_arn,
  :config_snapshot_delivery_properties)
  SENSITIVE = []
  include Aws::Structure
end

#s3_key_prefix ⇒ String

The prefix for the specified Amazon S3 bucket.

Returns:

• (String)

# File 'lib/aws-sdk-configservice/types.rb', line 2656

class DeliveryChannel < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :s3_kms_key_arn,
  :sns_topic_arn,
  :config_snapshot_delivery_properties)
  SENSITIVE = []
  include Aws::Structure
end

#s3_kms_key_arn ⇒ String

The Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key (KMS key) used to encrypt objects delivered by Config. Must belong to the same Region as the destination S3 bucket.

Returns:

• (String)

# File 'lib/aws-sdk-configservice/types.rb', line 2656

class DeliveryChannel < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :s3_kms_key_arn,
  :sns_topic_arn,
  :config_snapshot_delivery_properties)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon SNS topic to which Config sends notifications about configuration changes.

If you choose a topic from another account, the topic must have policies that grant access permissions to Config. For more information, see [Permissions for the Amazon SNS Topic] in the *Config Developer Guide*.

[1]: docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html

Returns:

• (String)

# File 'lib/aws-sdk-configservice/types.rb', line 2656

class DeliveryChannel < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :s3_kms_key_arn,
  :sns_topic_arn,
  :config_snapshot_delivery_properties)
  SENSITIVE = []
  include Aws::Structure
end