software.amazon.awscdk.customresources

Class AwsSdkCall.Builder

java.lang.Object

software.amazon.awscdk.customresources.AwsSdkCall.Builder

Enclosing interface:

AwsSdkCall

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

A builder for AwsSdkCall

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AwsSdkCall.Builder	action(java.lang.String action) Sets the value of AwsSdkCall.getAction()
AwsSdkCall.Builder	apiVersion(java.lang.String apiVersion) Sets the value of AwsSdkCall.getApiVersion()
AwsSdkCall.Builder	assumedRoleArn(java.lang.String assumedRoleArn) Sets the value of AwsSdkCall.getAssumedRoleArn()
AwsSdkCall	build() Builds the configured instance.
AwsSdkCall.Builder	ignoreErrorCodesMatching(java.lang.String ignoreErrorCodesMatching) Sets the value of AwsSdkCall.getIgnoreErrorCodesMatching()
AwsSdkCall.Builder	outputPath(java.lang.String outputPath) Deprecated. use outputPaths instead
AwsSdkCall.Builder	outputPaths(java.util.List<java.lang.String> outputPaths) Sets the value of AwsSdkCall.getOutputPaths()
AwsSdkCall.Builder	parameters(java.lang.Object parameters) Sets the value of AwsSdkCall.getParameters()
AwsSdkCall.Builder	physicalResourceId(PhysicalResourceId physicalResourceId) Sets the value of AwsSdkCall.getPhysicalResourceId()
AwsSdkCall.Builder	region(java.lang.String region) Sets the value of AwsSdkCall.getRegion()
AwsSdkCall.Builder	service(java.lang.String service) Sets the value of AwsSdkCall.getService()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

action

public AwsSdkCall.Builder action(java.lang.String action)

Sets the value of AwsSdkCall.getAction()

Parameters:

action - The service action to call. This parameter is required.

Returns:

this

service

public AwsSdkCall.Builder service(java.lang.String service)

Sets the value of AwsSdkCall.getService()

Parameters:

service - The service to call. This parameter is required.

Returns:

this

apiVersion

public AwsSdkCall.Builder apiVersion(java.lang.String apiVersion)

Sets the value of AwsSdkCall.getApiVersion()

Parameters:

apiVersion - API version to use for the service.

Returns:

this

assumedRoleArn

public AwsSdkCall.Builder assumedRoleArn(java.lang.String assumedRoleArn)

Sets the value of AwsSdkCall.getAssumedRoleArn()

Parameters:

assumedRoleArn - 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

Returns:

this

ignoreErrorCodesMatching

public AwsSdkCall.Builder ignoreErrorCodesMatching(java.lang.String ignoreErrorCodesMatching)

Sets the value of AwsSdkCall.getIgnoreErrorCodesMatching()

Parameters:

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

Returns:

this

outputPath

@Deprecated
public AwsSdkCall.Builder outputPath(java.lang.String outputPath)

Deprecated. use outputPaths instead

Sets the value of AwsSdkCall.getOutputPath()

Parameters:

outputPath - 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'

Returns:

this

outputPaths

public AwsSdkCall.Builder outputPaths(java.util.List<java.lang.String> outputPaths)

Sets the value of AwsSdkCall.getOutputPaths()

Parameters:

outputPaths - 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']

Returns:

this

parameters

public AwsSdkCall.Builder parameters(java.lang.Object parameters)

Sets the value of AwsSdkCall.getParameters()

Parameters:

parameters - The parameters for the service action.

Returns:

this

physicalResourceId

public AwsSdkCall.Builder physicalResourceId(PhysicalResourceId physicalResourceId)

Sets the value of AwsSdkCall.getPhysicalResourceId()

Parameters:

physicalResourceId - The physical resource id of the custom resource for this call. Mandatory for onCreate or onUpdate calls.

Returns:

this

region

public AwsSdkCall.Builder region(java.lang.String region)

Sets the value of AwsSdkCall.getRegion()

Parameters:

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

Returns:

this

build

public AwsSdkCall build()

Builds the configured instance.

Returns:

a new instance of AwsSdkCall

Throws:

java.lang.NullPointerException - if any required attribute was not provided