You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DeliveryChannel as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "ChannelName",
  s3_bucket_name: "String",
  s3_key_prefix: "String",
  sns_topic_arn: "String",
  config_snapshot_delivery_properties: {
    delivery_frequency: "One_Hour", # accepts One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours
  },
}

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#config_snapshot_delivery_properties ⇒ Types::ConfigSnapshotDeliveryProperties

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

Returns:

#name ⇒ String

The name of the delivery channel. By default, AWS 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) —

    The name of the delivery channel.

#s3_bucket_name ⇒ String

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

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

Returns:

  • (String) —

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

#s3_key_prefix ⇒ String

The prefix for the specified Amazon S3 bucket.

Returns:

  • (String) —

    The prefix for the specified Amazon S3 bucket.

#sns_topic_arn ⇒ String

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

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

Returns:

  • (String) —

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