software.amazon.awscdk.customresources

Class AwsSdkCall.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

AwsSdkCall, software.amazon.jsii.JsiiSerializable

Enclosing interface:

AwsSdkCall

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

An implementation for AwsSdkCall

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.AwsSdkCall

AwsSdkCall.Builder, AwsSdkCall.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.
protected	Jsii$Proxy(String action, String service, String apiVersion, String assumedRoleArn, String ignoreErrorCodesMatching, List<String> outputPaths, Object parameters, PhysicalResourceId physicalResourceId, String region) Constructor that initializes the object based on literal property values passed by the AwsSdkCall.Builder.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
String	getAction() (experimental) The service action to call.
String	getApiVersion() (experimental) API version to use for the service.
String	getAssumedRoleArn() (experimental) Used for running the SDK calls in underlying lambda with a different role Can be used primarily for cross-account requests to for example connect hostedzone with a shared vpc.
String	getIgnoreErrorCodesMatching() (experimental) The regex pattern to use to catch API errors.
List<String>	getOutputPaths() (experimental) Restrict the data returned by the custom resource to specific paths in the API response.
Object	getParameters() (experimental) The parameters for the service action.
PhysicalResourceId	getPhysicalResourceId() (experimental) The physical resource id of the custom resource for this call.
String	getRegion() (experimental) The region to send service requests to.
String	getService() (experimental) The service to call.
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.AwsSdkCall

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(String action,
                     String service,
                     String apiVersion,
                     String assumedRoleArn,
                     String ignoreErrorCodesMatching,
                     List<String> outputPaths,
                     Object parameters,
                     PhysicalResourceId physicalResourceId,
                     String region)

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

Method Detail

getAction

public final String getAction()

Description copied from interface: AwsSdkCall

(experimental) The service action to call.

Specified by:

getAction in interface AwsSdkCall

See Also:

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/index.html

getService

public final String getService()

Description copied from interface: AwsSdkCall

(experimental) The service to call.

Specified by:

getService in interface AwsSdkCall

See Also:

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/index.html

getApiVersion

public final String getApiVersion()

Description copied from interface: AwsSdkCall

(experimental) API version to use for the service.

Default: - use latest available API version

Specified by:

getApiVersion in interface AwsSdkCall

See Also:

https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/locking-api-versions.html

getAssumedRoleArn

public final String getAssumedRoleArn()

Description copied from interface: AwsSdkCall

(experimental) Used for running the SDK calls in underlying lambda with a different role Can be used primarily for cross-account requests to for example connect hostedzone with a shared vpc.

Example for Route53 / associateVPCWithHostedZone

Default: - run without assuming role

Specified by:

getAssumedRoleArn in interface AwsSdkCall

getIgnoreErrorCodesMatching

public final String getIgnoreErrorCodesMatching()

Description copied from interface: AwsSdkCall

(experimental) The regex pattern to use to catch API errors.

The code property of the Error object will be tested against this pattern. If there is a match an error will not be thrown.

Default: - do not catch errors

Specified by:

getIgnoreErrorCodesMatching in interface AwsSdkCall

getOutputPaths

public final List<String> getOutputPaths()

Description copied from interface: AwsSdkCall

(experimental) Restrict the data returned by the custom resource to specific paths in the API response.

Use this to limit the data returned by the custom resource if working with API calls that could potentially result in custom response objects exceeding the hard limit of 4096 bytes.

Example for ECS / updateService: ['service.deploymentConfiguration.maximumPercent']

Default: - return all data

Specified by:

getOutputPaths in interface AwsSdkCall

getParameters

public final Object getParameters()

Description copied from interface: AwsSdkCall

(experimental) The parameters for the service action.

Default: - no parameters

Specified by:

getParameters in interface AwsSdkCall

See Also:

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/index.html

getPhysicalResourceId

public final PhysicalResourceId getPhysicalResourceId()

Description copied from interface: AwsSdkCall

(experimental) The physical resource id of the custom resource for this call.

Mandatory for onCreate or onUpdate calls.

Default: - no physical resource id

Specified by:

getPhysicalResourceId in interface AwsSdkCall

getRegion

public final String getRegion()

Description copied from interface: AwsSdkCall

(experimental) The region to send service requests to.

Note: Cross-region operations are generally considered an anti-pattern. Consider first deploying a stack in that region.

Default: - the region where this custom resource is deployed

Specified by:

getRegion in interface AwsSdkCall

$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