Package software.amazon.awscdk

Class CustomResourceProviderProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.CustomResourceProviderProps.Jsii$Proxy
All Implemented Interfaces:
CustomResourceProviderOptions, CustomResourceProviderProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CustomResourceProviderProps
@Stability(Stable) @Internal public static final class CustomResourceProviderProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CustomResourceProviderProps
An implementation for CustomResourceProviderProps

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

  • Method Details

    • getCodeDirectory

      public final String getCodeDirectory()
      Description copied from interface: CustomResourceProviderProps
      A local file system directory with the provider's code.

      The code will be bundled into a zip asset and wired to the provider's AWS Lambda function.

      Specified by:
      getCodeDirectory in interface CustomResourceProviderProps

    • getRuntime

      public final CustomResourceProviderRuntime getRuntime()
      Description copied from interface: CustomResourceProviderProps
      The AWS Lambda runtime and version to use for the provider.
      Specified by:
      getRuntime in interface CustomResourceProviderProps

    • getDescription

      public final String getDescription()
      Description copied from interface: CustomResourceProviderOptions
      A description of the function.

      Default: - No description.

      Specified by:
      getDescription in interface CustomResourceProviderOptions

    • getEnvironment

      public final Map<String,String> getEnvironment()
      Description copied from interface: CustomResourceProviderOptions
      Key-value pairs that are passed to Lambda as Environment.

      Default: - No environment variables.

      Specified by:
      getEnvironment in interface CustomResourceProviderOptions

    • getMemorySize

      public final Size getMemorySize()
      Description copied from interface: CustomResourceProviderOptions
      The amount of memory that your function has access to.

      Increasing the function's memory also increases its CPU allocation.

      Default: Size.mebibytes(128)

      Specified by:
      getMemorySize in interface CustomResourceProviderOptions

    • getPolicyStatements

      public final List<Object> getPolicyStatements()
      Description copied from interface: CustomResourceProviderOptions
      A set of IAM policy statements to include in the inline policy of the provider's lambda function.

      Please note: these are direct IAM JSON policy blobs, not iam.PolicyStatement objects like you will see in the rest of the CDK.

      Default: - no additional inline policy

      Example: 

       CustomResourceProvider provider = CustomResourceProvider.getOrCreateProvider(this, "Custom::MyCustomResourceType", CustomResourceProviderProps.builder()
         .codeDirectory(String.format("%s/my-handler", __dirname))
         .runtime(CustomResourceProviderRuntime.NODEJS_18_X)
         .policyStatements(List.of(Map.of(
                 "Effect", "Allow",
                 "Action", "s3:PutObject*",
                 "Resource", "*")))
         .build());
      Specified by:
      getPolicyStatements in interface CustomResourceProviderOptions

    • getTimeout

      public final Duration getTimeout()
      Description copied from interface: CustomResourceProviderOptions
      AWS Lambda timeout for the provider.

      Default: Duration.minutes(15)

      Specified by:
      getTimeout in interface CustomResourceProviderOptions

    • getUseCfnResponseWrapper

      public final Boolean getUseCfnResponseWrapper()
      Description copied from interface: CustomResourceProviderOptions
      Whether or not the cloudformation response wrapper (nodejs-entrypoint.ts) is used. If set to true, nodejs-entrypoint.js is bundled in the same asset as the custom resource and set as the entrypoint. If set to false, the custom resource provided is the entrypoint.

      Default: - `true` if `inlineCode: false` and `false` otherwise.

      Specified by:
      getUseCfnResponseWrapper in interface CustomResourceProviderOptions

    • $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