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

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

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

Overview

Note:

When making an API call, you may pass DeliveryChannel data as a 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.

Instance Attribute Summary collapse

Instance Attribute Details

#config_snapshot_delivery_propertiesTypes::ConfigSnapshotDeliveryProperties

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



913
914
915
916
917
918
919
920
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 913

class DeliveryChannel < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_arn,
  :config_snapshot_delivery_properties)
  include Aws::Structure
end

#nameString

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)


913
914
915
916
917
918
919
920
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 913

class DeliveryChannel < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_arn,
  :config_snapshot_delivery_properties)
  include Aws::Structure
end

#s3_bucket_nameString

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)


913
914
915
916
917
918
919
920
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 913

class DeliveryChannel < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_arn,
  :config_snapshot_delivery_properties)
  include Aws::Structure
end

#s3_key_prefixString

The prefix for the specified Amazon S3 bucket.

Returns:

  • (String)


913
914
915
916
917
918
919
920
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 913

class DeliveryChannel < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_arn,
  :config_snapshot_delivery_properties)
  include Aws::Structure
end

#sns_topic_arnString

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)


913
914
915
916
917
918
919
920
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 913

class DeliveryChannel < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_arn,
  :config_snapshot_delivery_properties)
  include Aws::Structure
end