AwsCustomResourceProps

All Known Implementing Classes:: AwsCustomResourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:20:01.355Z")
public interface AwsCustomResourceProps

Properties for AwsCustomResource.

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

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	Interface and Description
`static class`	`AwsCustomResourceProps.Builder` A builder for `AwsCustomResourceProps`
`static class`	`AwsCustomResourceProps.Jsii$Proxy` An implementation for `AwsCustomResourceProps`

Method Summary

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

- Method Detail
  - getPolicy
```
AwsCustomResourcePolicy getPolicy()
```
    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
```
default java.lang.String getFunctionName()
```
    A name for the singleton Lambda function implementing this custom resource.
    The function name will remain the same after the first AwsCustomResource is created in a stack.
    Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the function's name. For more information, see Name Type.
  - getInstallLatestAwsSdk
```
default java.lang.Boolean getInstallLatestAwsSdk()
```
    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
```
default RetentionDays getLogRetention()
```
    The number of days log events of the singleton Lambda function implementing this custom resource are kept in CloudWatch Logs.
    Default: logs.RetentionDays.INFINITE
  - getOnCreate
```
default AwsSdkCall getOnCreate()
```
    The AWS SDK call to make when the resource is created.
    Default: - the call when the resource is updated
  - getOnDelete
```
default AwsSdkCall getOnDelete()
```
    The AWS SDK call to make when the resource is deleted.
    Default: - no call
  - getOnUpdate
```
default AwsSdkCall getOnUpdate()
```
    The AWS SDK call to make when the resource is updated.
    Default: - no call
  - getResourceType
```
default java.lang.String getResourceType()
```
    Cloudformation Resource type.
    Default: - Custom::AWS
  - getRole
```
default IRole getRole()
```
    The execution role for the singleton 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
```
default Duration getTimeout()
```
    The timeout for the singleton Lambda function implementing this custom resource.
    Default: Duration.minutes(2)
  - builder
```
static AwsCustomResourceProps.Builder builder()
```
    Returns:
    
    a AwsCustomResourceProps.Builder of AwsCustomResourceProps

Interface AwsCustomResourceProps

Nested Class Summary

Method Summary

Method Detail

getPolicy

getFunctionName

getInstallLatestAwsSdk

getLogRetention

getOnCreate

getOnDelete

getOnUpdate

getResourceType

getRole

getTimeout

builder