Package 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(Stable) @Internal public static final class AwsSdkCall.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements AwsSdkCall
An implementation for AwsSdkCall

  • Constructor Details

    • 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(AwsSdkCall.Builder builder)
      Constructor that initializes the object based on literal property values passed by the AwsSdkCall.Builder.

  • Method Details

    • getAction

      public final String getAction()
      Description copied from interface: AwsSdkCall
      The service action to call.

      This is the name of an AWS API call, in one of the following forms:

      • An API call name as found in the API Reference documentation (GetObject)
      • The API call name starting with a lowercase letter (getObject)
      • The AWS SDK for JavaScript v3 command class name (GetObjectCommand)

      Specified by:
      getAction in interface AwsSdkCall
      See Also:

    • getService

      public final String getService()
      Description copied from interface: AwsSdkCall
      The service to call.

      This is the name of an AWS service, in one of the following forms:

      • An AWS SDK for JavaScript v3 package name (@aws-sdk/client-api-gateway)
      • An AWS SDK for JavaScript v3 client name (api-gateway)
      • An AWS SDK for JavaScript v2 constructor name (APIGateway)
      • A lowercase AWS SDK for JavaScript v2 constructor name (apigateway)

      Specified by:
      getService in interface AwsSdkCall
      See Also:

    • getApiVersion

      public final String getApiVersion()
      Description copied from interface: AwsSdkCall
      API version to use for the service.

      Default: - use latest available API version

      Specified by:
      getApiVersion in interface AwsSdkCall
      See Also:

    • getAssumedRoleArn

      public final String getAssumedRoleArn()
      Description copied from interface: AwsSdkCall
      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. Region controls where assumeRole call is made.

      Example for Route53 / associateVPCWithHostedZone

      Default: - run without assuming role

      Specified by:
      getAssumedRoleArn in interface AwsSdkCall

    • getExternalId

      public final String getExternalId()
      Description copied from interface: AwsSdkCall
      External ID to use when assuming the role for cross-account requests.

      This is an additional security measure that helps prevent the "confused deputy" problem where an entity that doesn't have permission to perform an action can coerce a more-privileged entity to perform the action.

      The external ID must be provided by the third-party service and should not be generated by you. This value should be unique among the third-party service's customers.

      This property is only used when assumedRoleArn is specified.

      Default: - no external ID

      Specified by:
      getExternalId in interface AwsSdkCall
      See Also:

    • getIgnoreErrorCodesMatching

      public final String getIgnoreErrorCodesMatching()
      Description copied from interface: AwsSdkCall
      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

    • getLogging

      public final Logging getLogging()
      Description copied from interface: AwsSdkCall
      A property used to configure logging during lambda function execution.

      Note: The default Logging configuration is all. This configuration will enable logging on all logged data in the lambda handler. This includes:

      • The event object that is received by the lambda handler
      • The response received after making a API call
      • The response object that the lambda handler will return
      • SDK versioning information
      • Caught and uncaught errors

      Default: Logging.all()

      Specified by:
      getLogging in interface AwsSdkCall

    • getOutputPaths

      public final List<String> getOutputPaths()
      Description copied from interface: AwsSdkCall
      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
      The parameters for the service action.

      Default: - no parameters

      Specified by:
      getParameters in interface AwsSdkCall
      See Also:

    • getPhysicalResourceId

      public final PhysicalResourceId getPhysicalResourceId()
      Description copied from interface: AwsSdkCall
      The physical resource id of the custom resource for this call.

      Mandatory for onCreate call. In onUpdate, you can omit this to passthrough it from request.

      Default: - no physical resource id

      Specified by:
      getPhysicalResourceId in interface AwsSdkCall

    • getRegion

      public final String getRegion()
      Description copied from interface: AwsSdkCall
      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