software.amazon.awscdk.customresources

Class AwsCustomResourceProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.customresources.AwsCustomResourceProps.Jsii$Proxy

All Implemented Interfaces:

AwsCustomResourceProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

AwsCustomResourceProps

@Stability(value=Stable)
 @Internal
public static final class AwsCustomResourceProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements AwsCustomResourceProps

An implementation for AwsCustomResourceProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.customresources.AwsCustomResourceProps

AwsCustomResourceProps.Builder, AwsCustomResourceProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(AwsCustomResourceProps.Builder builder) Constructor that initializes the object based on literal property values passed by the AwsCustomResourceProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
String	getFunctionName() A name for the singleton Lambda function implementing this custom resource.
Boolean	getInstallLatestAwsSdk() Whether to install the latest AWS SDK v2.
RetentionDays	getLogRetention() The number of days log events of the singleton Lambda function implementing this custom resource are kept in CloudWatch Logs.
AwsSdkCall	getOnCreate() The AWS SDK call to make when the resource is created.
AwsSdkCall	getOnDelete() The AWS SDK call to make when the resource is deleted.
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.
String	getResourceType() Cloudformation Resource type.
IRole	getRole() The execution role for the singleton Lambda function implementing this custom resource provider.
Duration	getTimeout() The timeout for the singleton Lambda function implementing this custom resource.
IVpc	getVpc() The vpc to provision the lambda function in.
SubnetSelection	getVpcSubnets() Which subnets from the VPC to place the lambda function in.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.customresources.AwsCustomResourceProps

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(AwsCustomResourceProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the AwsCustomResourceProps.Builder.

Method Detail

getFunctionName

public final String getFunctionName()

Description copied from interface: AwsCustomResourceProps

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.

Specified by:

getFunctionName in interface AwsCustomResourceProps

getInstallLatestAwsSdk

public final Boolean getInstallLatestAwsSdk()

Description copied from interface: AwsCustomResourceProps

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

Specified by:

getInstallLatestAwsSdk in interface AwsCustomResourceProps

getLogRetention

public final RetentionDays getLogRetention()

Description copied from interface: AwsCustomResourceProps

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

Default: logs.RetentionDays.INFINITE

Specified by:

getLogRetention in interface AwsCustomResourceProps

getOnCreate

public final AwsSdkCall getOnCreate()

Description copied from interface: AwsCustomResourceProps

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

Default: - the call when the resource is updated

Specified by:

getOnCreate in interface AwsCustomResourceProps

getOnDelete

public final AwsSdkCall getOnDelete()

Description copied from interface: AwsCustomResourceProps

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

Default: - no call

Specified by:

getOnDelete in interface AwsCustomResourceProps

getOnUpdate

public final AwsSdkCall getOnUpdate()

Description copied from interface: AwsCustomResourceProps

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

Default: - no call

Specified by:

getOnUpdate in interface AwsCustomResourceProps

getPolicy

public final AwsCustomResourcePolicy getPolicy()

Description copied from interface: AwsCustomResourceProps

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.

Note that a policy must be specified if role is not provided, as by default a new role is created which requires policy changes to access resources.

Default: - no policy added

Specified by:

getPolicy in interface AwsCustomResourceProps

See Also:

Policy.fromSdkCalls

getResourceType

public final String getResourceType()

Description copied from interface: AwsCustomResourceProps

Cloudformation Resource type.

Default: - Custom::AWS

Specified by:

getResourceType in interface AwsCustomResourceProps

getRole

public final IRole getRole()

Description copied from interface: AwsCustomResourceProps

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

Specified by:

getRole in interface AwsCustomResourceProps

getTimeout

public final Duration getTimeout()

Description copied from interface: AwsCustomResourceProps

The timeout for the singleton Lambda function implementing this custom resource.

Default: Duration.minutes(2)

Specified by:

getTimeout in interface AwsCustomResourceProps

getVpc

public final IVpc getVpc()

Description copied from interface: AwsCustomResourceProps

The vpc to provision the lambda function in.

Default: - the function is not provisioned inside a vpc.

Specified by:

getVpc in interface AwsCustomResourceProps

getVpcSubnets

public final SubnetSelection getVpcSubnets()

Description copied from interface: AwsCustomResourceProps

Which subnets from the VPC to place the lambda function in.

Only used if 'vpc' is supplied. Note: internet access for Lambdas requires a NAT gateway, so picking Public subnets is not allowed.

Default: - the Vpc default strategy if not specified

Specified by:

getVpcSubnets in interface AwsCustomResourceProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object