Package software.amazon.awscdk.customresources

Class AwsSdkCall.Builder

java.lang.Object
software.amazon.awscdk.customresources.AwsSdkCall.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<AwsSdkCall>
Enclosing interface:
AwsSdkCall
@Stability(Stable) public static final class AwsSdkCall.Builder extends Object implements software.amazon.jsii.Builder<AwsSdkCall>
A builder for AwsSdkCall

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • action

      @Stability(Stable) public AwsSdkCall.Builder action(String action)
      Sets the value of AwsSdkCall.getAction()
      Parameters:
      action - The service action to call. This parameter is required.
      Returns:
      this

    • service

      @Stability(Stable) public AwsSdkCall.Builder service(String service)
      Sets the value of AwsSdkCall.getService()
      Parameters:
      service - The service to call. This parameter is required.
      Returns:
      this

    • apiVersion

      @Stability(Stable) public AwsSdkCall.Builder apiVersion(String apiVersion)
      Sets the value of AwsSdkCall.getApiVersion()
      Parameters:
      apiVersion - API version to use for the service.
      Returns:
      this

    • assumedRoleArn

      @Stability(Stable) public AwsSdkCall.Builder assumedRoleArn(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

      @Stability(Stable) public AwsSdkCall.Builder ignoreErrorCodesMatching(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

      @Stability(Deprecated) @Deprecated public AwsSdkCall.Builder outputPath(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

      @Stability(Stable) public AwsSdkCall.Builder outputPaths(List<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

      @Stability(Stable) public AwsSdkCall.Builder parameters(Object parameters)
      Sets the value of AwsSdkCall.getParameters()
      Parameters:
      parameters - The parameters for the service action.
      Returns:
      this

    • physicalResourceId

      @Stability(Stable) 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

      @Stability(Stable) public AwsSdkCall.Builder region(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

      @Stability(Stable) public AwsSdkCall build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<AwsSdkCall>
      Returns:
      a new instance of AwsSdkCall
      Throws:
      NullPointerException - if any required attribute was not provided