Package software.amazon.awscdk.mixins.preview.services.cloudformation.mixins

Class CfnCustomResourcePropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.mixins.preview.core.Mixin
software.amazon.awscdk.mixins.preview.services.cloudformation.mixins.CfnCustomResourcePropsMixin
All Implemented Interfaces:
IMixin, software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:23.704Z") @Stability(Stable) public class CfnCustomResourcePropsMixin extends Mixin implements IMixin
The AWS::CloudFormation::CustomResource resource creates a custom resource.

Custom resources provide a way for you to write custom provisioning logic into your CloudFormation templates and have CloudFormation run it anytime you create, update (if you changed the custom resource), or delete a stack.

For more information, see Create custom provisioning logic with custom resources in the CloudFormation User Guide .

If you use AWS PrivateLink , custom resources in the VPC must have access to CloudFormation -specific Amazon S3 buckets. Custom resources must send responses to a presigned Amazon S3 URL. If they can't send responses to Amazon S3 , CloudFormation won't receive a response and the stack operation fails. For more information, see Access CloudFormation using an interface endpoint ( AWS PrivateLink ) in the CloudFormation User 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.mixins.preview.mixins.*;
 import software.amazon.awscdk.mixins.preview.services.cloudformation.mixins.*;
 CfnCustomResourcePropsMixin cfnCustomResourcePropsMixin = CfnCustomResourcePropsMixin.Builder.create(CfnCustomResourceMixinProps.builder()
         .serviceTimeout(123)
         .serviceToken("serviceToken")
         .build())
 .strategy(PropertyMergeStrategy.OVERRIDE)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

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

  • Constructor Details

    • CfnCustomResourcePropsMixin

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

    • CfnCustomResourcePropsMixin

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

    • CfnCustomResourcePropsMixin

      @Stability(Stable) public CfnCustomResourcePropsMixin(@NotNull CfnCustomResourceMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::CloudFormation::CustomResource.

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

    • CfnCustomResourcePropsMixin

      @Stability(Stable) public CfnCustomResourcePropsMixin(@NotNull CfnCustomResourceMixinProps props)
      Create a mixin to apply properties to AWS::CloudFormation::CustomResource.

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

  • Method Details

    • applyTo

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

      Specified by:
      applyTo in interface 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 IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

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

    • getStrategy

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