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.84.0 (build 5404dcf)", date="2023-06-19T16:30:48.570Z") @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();

  • 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 .

    • getConfigSnapshotDeliveryProperties

      @Stability(Stable) @Nullable default Object getConfigSnapshotDeliveryProperties()
      The options for how often AWS Config delivers configuration snapshots to the Amazon S3 bucket.

    • 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.

    • getS3KeyPrefix

      @Stability(Stable) @Nullable default String getS3KeyPrefix()
      The prefix for the specified Amazon S3 bucket.

    • 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.

    • 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 .

    • builder

      @Stability(Stable) static CfnDeliveryChannelProps.Builder builder()
      Returns:
      a CfnDeliveryChannelProps.Builder of CfnDeliveryChannelProps