software.amazon.awscdk.customresources

Interface AwsSdkCall

All Known Implementing Classes:

AwsSdkCall.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:30.888Z")
public interface AwsSdkCall

An AWS SDK call.

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	AwsSdkCall.Builder A builder for AwsSdkCall
static class	AwsSdkCall.Jsii$Proxy An implementation for AwsSdkCall

Method Summary

Modifier and Type	Method and Description
static AwsSdkCall.Builder	builder()
java.lang.String	getAction() The service action to call.
default java.lang.String	getApiVersion() API version to use for the service.
default java.lang.String	getAssumedRoleArn() 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.
default java.lang.String	getIgnoreErrorCodesMatching() The regex pattern to use to catch API errors.
default java.lang.String	getOutputPath() Deprecated. use outputPaths instead
default java.util.List<java.lang.String>	getOutputPaths() Restrict the data returned by the custom resource to specific paths in the API response.
default java.lang.Object	getParameters() The parameters for the service action.
default PhysicalResourceId	getPhysicalResourceId() The physical resource id of the custom resource for this call.
default java.lang.String	getRegion() The region to send service requests to.
java.lang.String	getService() The service to call.

Method Detail

getAction

java.lang.String getAction()

The service action to call.

See Also:

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

getService

java.lang.String getService()

The service to call.

See Also:

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

getApiVersion

default java.lang.String getApiVersion()

API version to use for the service.

Default: - use latest available API version

See Also:

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

getAssumedRoleArn

default java.lang.String getAssumedRoleArn()

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

getIgnoreErrorCodesMatching

default java.lang.String getIgnoreErrorCodesMatching()

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

getOutputPath

@Deprecated
default java.lang.String getOutputPath()

Deprecated. use outputPaths instead

(deprecated) Restrict the data returned by the custom resource to a specific path 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

getOutputPaths

default java.util.List<java.lang.String> getOutputPaths()

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

getParameters

default java.lang.Object getParameters()

The parameters for the service action.

Default: - no parameters

See Also:

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

getPhysicalResourceId

default PhysicalResourceId getPhysicalResourceId()

The physical resource id of the custom resource for this call.

Mandatory for onCreate or onUpdate calls.

Default: - no physical resource id

getRegion

default java.lang.String getRegion()

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

builder

static AwsSdkCall.Builder builder()

Returns:

a AwsSdkCall.Builder of AwsSdkCall