software.amazon.awscdk.customresources

Class AwsCustomResource

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.customresources.AwsCustomResource

All Implemented Interfaces:

IConstruct, IDependable, IGrantable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:45.220Z")
public class AwsCustomResource
extends Construct
implements IGrantable

Defines a custom resource that is materialized using specific AWS API calls.

These calls are created using a singleton Lambda function.

Use this to bridge any gap that might exist in the CloudFormation Coverage. You can specify exactly which calls are invoked for the 'CREATE', 'UPDATE' and 'DELETE' life cycle events.

Example:

 AwsCustomResource awsCustom = AwsCustomResource.Builder.create(this, "aws-custom")
         .onCreate(AwsSdkCall.builder()
                 .service("...")
                 .action("...")
                 .parameters(Map.of(
                         "text", "..."))
                 .physicalResourceId(PhysicalResourceId.of("..."))
                 .build())
         .onUpdate(AwsSdkCall.builder()
                 .service("...")
                 .action("...")
                 .parameters(Map.of(
                         "text", "...",
                         "resourceId", new PhysicalResourceIdReference()))
                 .build())
         .policy(AwsCustomResourcePolicy.fromSdkCalls(SdkCallsPolicyOptions.builder()
                 .resources(AwsCustomResourcePolicy.ANY_RESOURCE)
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AwsCustomResource.Builder A fluent builder for AwsCustomResource.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IGrantable

IGrantable.Jsii$Default, IGrantable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AwsCustomResource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AwsCustomResource(software.amazon.jsii.JsiiObjectRef objRef)
	AwsCustomResource(software.constructs.Construct scope, java.lang.String id, AwsCustomResourceProps props)

Method Summary

Modifier and Type	Method and Description
IPrincipal	getGrantPrincipal() The principal to grant permissions to.
java.lang.String	getResponseField(java.lang.String dataPath) Returns response data for the AWS SDK call as string.
Reference	getResponseFieldReference(java.lang.String dataPath) Returns response data for the AWS SDK call.

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AwsCustomResource

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

AwsCustomResource

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

AwsCustomResource

public AwsCustomResource(software.constructs.Construct scope,
                         java.lang.String id,
                         AwsCustomResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

getResponseField

public java.lang.String getResponseField(java.lang.String dataPath)

Returns response data for the AWS SDK call as string.

Example for S3 / listBucket : 'Buckets.0.Name'

Note that you cannot use this method if ignoreErrorCodesMatching is configured for any of the SDK calls. This is because in such a case, the response data might not exist, and will cause a CloudFormation deploy time error.

Parameters:

dataPath - the path to the data. This parameter is required.

getResponseFieldReference

public Reference getResponseFieldReference(java.lang.String dataPath)

Returns response data for the AWS SDK call.

Example for S3 / listBucket : 'Buckets.0.Name'

Use Token.asXxx to encode the returned Reference as a specific type or use the convenience getDataString for string attributes.

Note that you cannot use this method if ignoreErrorCodesMatching is configured for any of the SDK calls. This is because in such a case, the response data might not exist, and will cause a CloudFormation deploy time error.

Parameters:

dataPath - the path to the data. This parameter is required.

getGrantPrincipal

public IPrincipal getGrantPrincipal()

The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable