Package software.amazon.awscdk

Class CustomResourceProviderBase

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CustomResourceProviderBase
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
Direct Known Subclasses:
CustomResourceProvider
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-21T06:34:02.164Z") @Stability(Stable) public abstract class CustomResourceProviderBase extends software.constructs.Construct
Base class for creating a custom resource provider.

  • 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.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    CustomResourceProviderBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    CustomResourceProviderBase(software.amazon.jsii.JsiiObjectRef objRef)
     
    protected
    CustomResourceProviderBase(software.constructs.Construct scope, String id, CustomResourceProviderBaseProps props)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addToRolePolicy(Object statement)
    Add an IAM policy statement to the inline policy of the provider's lambda function's role.
    String
    getCodeHash()
    The hash of the lambda code backing this provider.
    String
    getRoleArn()
    The ARN of the provider's AWS Lambda function role.
    String
    getServiceToken()
    The ARN of the provider's AWS Lambda function which should be used as the serviceToken when defining a custom resource.

    Methods inherited from class software.constructs.Construct

    getNode, isConstruct, toString

    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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • CustomResourceProviderBase

      protected CustomResourceProviderBase(software.amazon.jsii.JsiiObjectRef objRef)

    • CustomResourceProviderBase

      protected CustomResourceProviderBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CustomResourceProviderBase

      @Stability(Stable) protected CustomResourceProviderBase(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CustomResourceProviderBaseProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • addToRolePolicy

      @Stability(Stable) public void addToRolePolicy(@NotNull Object statement)
      Add an IAM policy statement to the inline policy of the provider's lambda function's role.

      Please note: this is a direct IAM JSON policy blob, not a iam.PolicyStatement object like you will see in the rest of the CDK.

      Example: 

       CustomResourceProvider myProvider;
 myProvider.addToRolePolicy(Map.of(
         "Effect", "Allow",
         "Action", "s3:GetObject",
         "Resource", "*"));

      Parameters:
      statement - This parameter is required.

    • getCodeHash

      @Stability(Stable) @NotNull public String getCodeHash()
      The hash of the lambda code backing this provider.

      Can be used to trigger updates on code changes, even when the properties of a custom resource remain unchanged.

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()
      The ARN of the provider's AWS Lambda function role.

    • getServiceToken

      @Stability(Stable) @NotNull public String getServiceToken()
      The ARN of the provider's AWS Lambda function which should be used as the serviceToken when defining a custom resource.