class CfnCustomResourcePropsMixin

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.CloudFormation.CfnCustomResourcePropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awscloudformation#CfnCustomResourcePropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.cloudformation.CfnCustomResourcePropsMixin
Python	aws_cdk.cfn_property_mixins.aws_cloudformation.CfnCustomResourcePropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_cloudformation » CfnCustomResourcePropsMixin

Implements IMixin

Extends Mixin

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-customresource.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudformation as cloudformation } from '@aws-cdk/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnCustomResourcePropsMixin = new cloudformation.CfnCustomResourcePropsMixin({
  serviceTimeout: 123,
  serviceToken: 'serviceToken',
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnCustomResourcePropsMixin(props: CfnCustomResourceMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnCustomResourceMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::CloudFormation::CustomResource.

Properties

Name	Type	Description
props	CfnCustomResourceMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnCustomResourceMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.