AwsCustomResource.Builder

java.lang.Object
- software.amazon.awscdk.customresources.AwsCustomResource.Builder

Enclosing class:: AwsCustomResource

public static final class AwsCustomResource.Builder
extends java.lang.Object

A fluent builder for AwsCustomResource.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AwsCustomResource`	`build()`
`static AwsCustomResource.Builder`	`create(software.constructs.Construct scope, java.lang.String id)`
`AwsCustomResource.Builder`	`functionName(java.lang.String functionName)` A name for the singleton Lambda function implementing this custom resource.
`AwsCustomResource.Builder`	`installLatestAwsSdk(java.lang.Boolean installLatestAwsSdk)` Whether to install the latest AWS SDK v2.
`AwsCustomResource.Builder`	`logRetention(RetentionDays logRetention)` The number of days log events of the singleton Lambda function implementing this custom resource are kept in CloudWatch Logs.
`AwsCustomResource.Builder`	`onCreate(AwsSdkCall onCreate)` The AWS SDK call to make when the resource is created.
`AwsCustomResource.Builder`	`onDelete(AwsSdkCall onDelete)` The AWS SDK call to make when the resource is deleted.
`AwsCustomResource.Builder`	`onUpdate(AwsSdkCall onUpdate)` The AWS SDK call to make when the resource is updated.
`AwsCustomResource.Builder`	`policy(AwsCustomResourcePolicy policy)` The policy that will be added to the execution role of the Lambda function implementing this custom resource provider.
`AwsCustomResource.Builder`	`resourceType(java.lang.String resourceType)` Cloudformation Resource type.
`AwsCustomResource.Builder`	`role(IRole role)` The execution role for the singleton Lambda function implementing this custom resource provider.
`AwsCustomResource.Builder`	`timeout(Duration timeout)` The timeout for the singleton Lambda function implementing this custom resource.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static AwsCustomResource.Builder create(software.constructs.Construct scope,
                                               java.lang.String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    Returns:
    
    a new instance of AwsCustomResource.Builder.
  - policy
```
public AwsCustomResource.Builder policy(AwsCustomResourcePolicy policy)
```
    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.
    
    Parameters:
    
    policy - The policy that will be added to the execution role of the Lambda function implementing this custom resource provider. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    Policy.fromSdkCalls
  - functionName
```
public AwsCustomResource.Builder functionName(java.lang.String functionName)
```
    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.
    
    Parameters:
    
    functionName - A name for the singleton Lambda function implementing this custom resource. This parameter is required.
    
    Returns:
    
    this
  - installLatestAwsSdk
```
public AwsCustomResource.Builder installLatestAwsSdk(java.lang.Boolean installLatestAwsSdk)
```
    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
    
    Parameters:
    
    installLatestAwsSdk - 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. This parameter is required.
    
    Returns:
    
    this
  - logRetention
```
public AwsCustomResource.Builder logRetention(RetentionDays logRetention)
```
    The number of days log events of the singleton Lambda function implementing this custom resource are kept in CloudWatch Logs.
    Default: logs.RetentionDays.INFINITE
    
    Parameters:
    
    logRetention - The number of days log events of the singleton Lambda function implementing this custom resource are kept in CloudWatch Logs. This parameter is required.
    
    Returns:
    
    this
  - onCreate
```
public AwsCustomResource.Builder onCreate(AwsSdkCall onCreate)
```
    The AWS SDK call to make when the resource is created.
    Default: - the call when the resource is updated
    
    Parameters:
    
    onCreate - The AWS SDK call to make when the resource is created. This parameter is required.
    
    Returns:
    
    this
  - onDelete
```
public AwsCustomResource.Builder onDelete(AwsSdkCall onDelete)
```
    The AWS SDK call to make when the resource is deleted.
    Default: - no call
    
    Parameters:
    
    onDelete - The AWS SDK call to make when the resource is deleted. This parameter is required.
    
    Returns:
    
    this
  - onUpdate
```
public AwsCustomResource.Builder onUpdate(AwsSdkCall onUpdate)
```
    The AWS SDK call to make when the resource is updated.
    Default: - no call
    
    Parameters:
    
    onUpdate - The AWS SDK call to make when the resource is updated. This parameter is required.
    
    Returns:
    
    this
  - resourceType
```
public AwsCustomResource.Builder resourceType(java.lang.String resourceType)
```
    Cloudformation Resource type.
    Default: - Custom::AWS
    
    Parameters:
    
    resourceType - Cloudformation Resource type. This parameter is required.
    
    Returns:
    
    this
  - role
```
public AwsCustomResource.Builder role(IRole role)
```
    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
    
    Parameters:
    
    role - The execution role for the singleton Lambda function implementing this custom resource provider. This parameter is required.
    
    Returns:
    
    this
  - timeout
```
public AwsCustomResource.Builder timeout(Duration timeout)
```
    The timeout for the singleton Lambda function implementing this custom resource.
    Default: Duration.minutes(2)
    
    Parameters:
    
    timeout - The timeout for the singleton Lambda function implementing this custom resource. This parameter is required.
    
    Returns:
    
    this
  - build
```
public AwsCustomResource build()
```

Class AwsCustomResource.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

policy

functionName

installLatestAwsSdk

logRetention

onCreate

onDelete

onUpdate

resourceType

role

timeout

build