Package software.amazon.awscdk.services.config

Interface CfnDeliveryChannelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeliveryChannelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:55:55.573Z")
@Stability(Stable)
public interface CfnDeliveryChannelProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDeliveryChannel.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.config.*;
 CfnDeliveryChannelProps cfnDeliveryChannelProps = CfnDeliveryChannelProps.builder()
         .s3BucketName("s3BucketName")
         // the properties below are optional
         .configSnapshotDeliveryProperties(ConfigSnapshotDeliveryPropertiesProperty.builder()
                 .deliveryFrequency("deliveryFrequency")
                 .build())
         .name("name")
         .s3KeyPrefix("s3KeyPrefix")
         .s3KmsKeyArn("s3KmsKeyArn")
         .snsTopicArn("snsTopicArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDeliveryChannelProps.Builder	A builder for CfnDeliveryChannelProps
static final class	CfnDeliveryChannelProps.Jsii$Proxy	An implementation for CfnDeliveryChannelProps

Method Summary

Modifier and Type	Method	Description
static CfnDeliveryChannelProps.Builder	builder()
default Object	getConfigSnapshotDeliveryProperties()	The options for how often AWS Config delivers configuration snapshots to the Amazon S3 bucket.
default String	getName()	A name for the delivery channel.
String	getS3BucketName()	The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files.
default String	getS3KeyPrefix()	The prefix for the specified Amazon S3 bucket.
default String	getS3KmsKeyArn()	The Amazon Resource Name (ARN) of the AWS Key Management Service ( AWS KMS ) AWS KMS key (KMS key) used to encrypt objects delivered by AWS Config .
default String	getSnsTopicArn()	The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getS3BucketName

@Stability(Stable)
@NotNull
String getS3BucketName()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-s3bucketname

getConfigSnapshotDeliveryProperties

@Stability(Stable)
@Nullable
default Object getConfigSnapshotDeliveryProperties()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-configsnapshotdeliveryproperties

getName

@Stability(Stable)
@Nullable
default String getName()

A name for the delivery channel.

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the delivery channel name. For more information, see Name Type .

Updates are not supported. To change the name, you must run two separate updates. In the first update, delete this resource, and then recreate it with a new name in the second update.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-name

getS3KeyPrefix

@Stability(Stable)
@Nullable
default String getS3KeyPrefix()

The prefix for the specified Amazon S3 bucket.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-s3keyprefix

getS3KmsKeyArn

@Stability(Stable)
@Nullable
default String getS3KmsKeyArn()

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

Must belong to the same Region as the destination S3 bucket.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-s3kmskeyarn

getSnsTopicArn

@Stability(Stable)
@Nullable
default String getSnsTopicArn()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-snstopicarn

builder

@Stability(Stable)
static CfnDeliveryChannelProps.Builder builder()

Returns:

a CfnDeliveryChannelProps.Builder of CfnDeliveryChannelProps