Package software.amazon.awscdk.cfnpropertymixins.services.config

Class CfnDeliveryChannelPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.config.CfnDeliveryChannelPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:57.507Z") @Stability(Stable) public class CfnDeliveryChannelPropsMixin extends Mixin implements software.constructs.IMixin
Specifies a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon topic.

Before you can create a delivery channel, you must create a configuration recorder. You can use this action to change the Amazon S3 bucket or an Amazon topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed.

In the China (Beijing) Region, when you call this action, the Amazon S3 bucket must also be in the China (Beijing) Region. In all the other regions, AWS Config supports cross-region and cross-account delivery channels.

You can have only one delivery channel per region per AWS account, and the delivery channel is required to use AWS Config .

AWS Config does not support the delivery channel to an Amazon S3 bucket bucket where object lock is enabled. For more information, see How S3 Object Lock works .

When you create the delivery channel, you can specify; how often AWS Config delivers configuration snapshots to your Amazon S3 bucket (for example, 24 hours), the S3 bucket to which AWS Config sends configuration snapshots and configuration history files, and the Amazon topic to which AWS Config sends notifications about configuration changes, such as updated resources, AWS Config rule evaluations, and when AWS Config delivers the configuration snapshot to your S3 bucket. For more information, see Deliver Configuration Items in the AWS Config Developer Guide.

To enable AWS Config , you must create a configuration recorder and a delivery channel. If you want to create the resources separately, you must create a configuration recorder before you can create a delivery channel. AWS Config uses the configuration recorder to capture configuration changes to your resources. For more information, see AWS::Config::ConfigurationRecorder .

For more information, see Managing the Delivery Channel in the AWS Config Developer Guide.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.config.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnDeliveryChannelPropsMixin cfnDeliveryChannelPropsMixin = CfnDeliveryChannelPropsMixin.Builder.create(CfnDeliveryChannelMixinProps.builder()
         .configSnapshotDeliveryProperties(ConfigSnapshotDeliveryPropertiesProperty.builder()
                 .deliveryFrequency("deliveryFrequency")
                 .build())
         .name("name")
         .s3BucketName("s3BucketName")
         .s3KeyPrefix("s3KeyPrefix")
         .s3KmsKeyArn("s3KmsKeyArn")
         .snsTopicArn("snsTopicArn")
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnDeliveryChannelPropsMixin

      protected CfnDeliveryChannelPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDeliveryChannelPropsMixin

      protected CfnDeliveryChannelPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDeliveryChannelPropsMixin

      @Stability(Stable) public CfnDeliveryChannelPropsMixin(@NotNull CfnDeliveryChannelMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::Config::DeliveryChannel.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnDeliveryChannelPropsMixin

      @Stability(Stable) public CfnDeliveryChannelPropsMixin(@NotNull CfnDeliveryChannelMixinProps props)
      Create a mixin to apply properties to AWS::Config::DeliveryChannel.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnDeliveryChannelMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()