Package software.amazon.awscdk

Class CfnCustomResource

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.CfnCustomResource
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-06T23:25:02.969Z") @Stability(Stable) public class CfnCustomResource extends CfnResource implements IInspectable
In a CloudFormation template, you use the AWS::CloudFormation::CustomResource or Custom:: *String* resource type to specify custom resources.

Custom resources provide a way for you to write custom provisioning logic in CloudFormation template and have CloudFormation run it during a stack operation, such as when you create, update or delete a stack. For more information, see Custom resources .

If you use the VPC endpoints feature, custom resources in the VPC must have access to CloudFormation -specific Amazon Simple Storage Service ( 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 Setting up VPC endpoints for AWS CloudFormation .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 CfnCustomResource cfnCustomResource = CfnCustomResource.Builder.create(this, "MyCfnCustomResource")
         .serviceToken("serviceToken")
         // the properties below are optional
         .serviceTimeout(123)
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCustomResource

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

    • CfnCustomResource

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

    • CfnCustomResource

      @Stability(Stable) public CfnCustomResource(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCustomResourceProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getServiceToken

      @Stability(Stable) @NotNull public String getServiceToken()
      The service token, such as an Amazon SNS topic ARN or Lambda function ARN.

    • setServiceToken

      @Stability(Stable) public void setServiceToken(@NotNull String value)
      The service token, such as an Amazon SNS topic ARN or Lambda function ARN.

    • getServiceTimeout

      @Stability(Stable) @Nullable public Number getServiceTimeout()
      The maximum time, in seconds, that can elapse before a custom resource operation times out.

    • setServiceTimeout

      @Stability(Stable) public void setServiceTimeout(@Nullable Number value)
      The maximum time, in seconds, that can elapse before a custom resource operation times out.