software.amazon.awscdk.customresources

Interface AwsCustomResourceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AwsCustomResourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:16.470Z")
 @Stability(value=Experimental)
public interface AwsCustomResourceProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for AwsCustomResource.

Note that at least onCreate, onUpdate or onDelete must be specified.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.logs.*;
 import software.amazon.awscdk.customresources.*;
 AwsCustomResourcePolicy awsCustomResourcePolicy;
 Duration duration;
 Object parameters;
 PhysicalResourceId physicalResourceId;
 Role role;
 AwsCustomResourceProps awsCustomResourceProps = AwsCustomResourceProps.builder()
         .policy(awsCustomResourcePolicy)
         // the properties below are optional
         .functionName("functionName")
         .installLatestAwsSdk(false)
         .logRetention(RetentionDays.ONE_DAY)
         .onCreate(AwsSdkCall.builder()
                 .action("action")
                 .service("service")
                 // the properties below are optional
                 .apiVersion("apiVersion")
                 .assumedRoleArn("assumedRoleArn")
                 .ignoreErrorCodesMatching("ignoreErrorCodesMatching")
                 .outputPath("outputPath")
                 .outputPaths(List.of("outputPaths"))
                 .parameters(parameters)
                 .physicalResourceId(physicalResourceId)
                 .region("region")
                 .build())
         .onDelete(AwsSdkCall.builder()
                 .action("action")
                 .service("service")
                 // the properties below are optional
                 .apiVersion("apiVersion")
                 .assumedRoleArn("assumedRoleArn")
                 .ignoreErrorCodesMatching("ignoreErrorCodesMatching")
                 .outputPath("outputPath")
                 .outputPaths(List.of("outputPaths"))
                 .parameters(parameters)
                 .physicalResourceId(physicalResourceId)
                 .region("region")
                 .build())
         .onUpdate(AwsSdkCall.builder()
                 .action("action")
                 .service("service")
                 // the properties below are optional
                 .apiVersion("apiVersion")
                 .assumedRoleArn("assumedRoleArn")
                 .ignoreErrorCodesMatching("ignoreErrorCodesMatching")
                 .outputPath("outputPath")
                 .outputPaths(List.of("outputPaths"))
                 .parameters(parameters)
                 .physicalResourceId(physicalResourceId)
                 .region("region")
                 .build())
         .resourceType("resourceType")
         .role(role)
         .timeout(duration)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AwsCustomResourceProps.Builder A builder for AwsCustomResourceProps
static class	AwsCustomResourceProps.Jsii$Proxy An implementation for AwsCustomResourceProps

Method Summary

Modifier and Type	Method and Description
static AwsCustomResourceProps.Builder	builder()
default String	getFunctionName() (experimental) A name for the Lambda function implementing this custom resource.
default Boolean	getInstallLatestAwsSdk() (experimental) Whether to install the latest AWS SDK v2.
default RetentionDays	getLogRetention() (experimental) The number of days log events of the Lambda function implementing this custom resource are kept in CloudWatch Logs.
default AwsSdkCall	getOnCreate() (experimental) The AWS SDK call to make when the resource is created.
default AwsSdkCall	getOnDelete() (experimental) The AWS SDK call to make when the resource is deleted.
default AwsSdkCall	getOnUpdate() (experimental) The AWS SDK call to make when the resource is updated.
AwsCustomResourcePolicy	getPolicy() (experimental) The policy that will be added to the execution role of the Lambda function implementing this custom resource provider.
default String	getResourceType() (experimental) Cloudformation Resource type.
default IRole	getRole() (experimental) The execution role for the Lambda function implementing this custom resource provider.
default Duration	getTimeout() (experimental) The timeout for the Lambda function implementing this custom resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPolicy

@Stability(value=Experimental)
 @NotNull
AwsCustomResourcePolicy getPolicy()

(experimental) The policy that will be added to the execution role of the Lambda function implementing this custom resource provider.

The custom resource also implements iam.IGrantable, making it possible to use the grantXxx() methods.

As this custom resource uses a singleton Lambda function, it's important to note the that function's role will eventually accumulate the permissions/grants from all resources.

See Also:

Policy.fromSdkCalls

getFunctionName

@Stability(value=Experimental)
 @Nullable
default String getFunctionName()

(experimental) A name for the Lambda function implementing this custom resource.

Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the function's name. For more information, see Name Type.

getInstallLatestAwsSdk

@Stability(value=Experimental)
 @Nullable
default Boolean getInstallLatestAwsSdk()

(experimental) Whether to install the latest AWS SDK v2. Allows to use the latest API calls documented at https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/index.html.

The installation takes around 60 seconds.

Default: true

getLogRetention

@Stability(value=Experimental)
 @Nullable
default RetentionDays getLogRetention()

(experimental) The number of days log events of the Lambda function implementing this custom resource are kept in CloudWatch Logs.

Default: logs.RetentionDays.INFINITE

getOnCreate

@Stability(value=Experimental)
 @Nullable
default AwsSdkCall getOnCreate()

(experimental) The AWS SDK call to make when the resource is created.

Default: - the call when the resource is updated

getOnDelete

@Stability(value=Experimental)
 @Nullable
default AwsSdkCall getOnDelete()

(experimental) The AWS SDK call to make when the resource is deleted.

Default: - no call

getOnUpdate

@Stability(value=Experimental)
 @Nullable
default AwsSdkCall getOnUpdate()

(experimental) The AWS SDK call to make when the resource is updated.

Default: - no call

getResourceType

@Stability(value=Experimental)
 @Nullable
default String getResourceType()

(experimental) Cloudformation Resource type.

Default: - Custom::AWS

getRole

@Stability(value=Experimental)
 @Nullable
default IRole getRole()

(experimental) The execution role for the Lambda function implementing this custom resource provider.

This role will apply to all AwsCustomResource instances in the stack. The role must be assumable by the lambda.amazonaws.com service principal.

Default: - a new role is created

getTimeout

@Stability(value=Experimental)
 @Nullable
default Duration getTimeout()

(experimental) The timeout for the Lambda function implementing this custom resource.

Default: Duration.minutes(2)

builder

@Stability(value=Experimental)
static AwsCustomResourceProps.Builder builder()

Returns:

a AwsCustomResourceProps.Builder of AwsCustomResourceProps