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",
  s3_kms_key_arn: "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 Config delivers notifications and updated configuration states.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#config_snapshot_delivery_propertiesTypes::ConfigSnapshotDeliveryProperties

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



2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 2368

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

#nameString

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)


2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 2368

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_nameString

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.

Returns:

  • (String)


2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 2368

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_prefixString

The prefix for the specified Amazon S3 bucket.

Returns:

  • (String)


2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 2368

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_arnString

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)


2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 2368

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_arnString

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.

Returns:

  • (String)


2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 2368

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