Package software.amazon.awscdk.customresources

Class ProviderProps.Jsii$Proxy

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

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

  • Method Details

    • getOnEventHandler

      public final IFunction getOnEventHandler()
      Description copied from interface: ProviderProps
      The AWS Lambda function to invoke for all resource lifecycle operations (CREATE/UPDATE/DELETE).

      This function is responsible to begin the requested resource operation (CREATE/UPDATE/DELETE) and return any additional properties to add to the event, which will later be passed to isComplete. The PhysicalResourceId property must be included in the response.

      Specified by:
      getOnEventHandler in interface ProviderProps

    • getDisableWaiterStateMachineLogging

      public final Boolean getDisableWaiterStateMachineLogging()
      Description copied from interface: ProviderProps
      Whether logging for the waiter state machine is disabled.

      Default: - true

      Specified by:
      getDisableWaiterStateMachineLogging in interface ProviderProps

    • getFrameworkCompleteAndTimeoutRole

      public final IRole getFrameworkCompleteAndTimeoutRole()
      Description copied from interface: ProviderProps
      Lambda execution role for provider framework's isComplete/onTimeout Lambda function.

      Note that this role must be assumed by the 'lambda.amazonaws.com' service principal. To prevent circular dependency problem in the provider framework, please ensure you specify a different IAM Role for 'frameworkCompleteAndTimeoutRole' from 'frameworkOnEventRole'.

      This property cannot be used with 'role' property

      Default: - A default role will be created.

      Specified by:
      getFrameworkCompleteAndTimeoutRole in interface ProviderProps

    • getFrameworkLambdaLoggingLevel

      public final ApplicationLogLevel getFrameworkLambdaLoggingLevel()
      Description copied from interface: ProviderProps
      Log level of the provider framework lambda.

      Default: true - Logging is disabled by default

      Specified by:
      getFrameworkLambdaLoggingLevel in interface ProviderProps

    • getFrameworkOnEventRole

      public final IRole getFrameworkOnEventRole()
      Description copied from interface: ProviderProps
      Lambda execution role for provider framework's onEvent Lambda function.

      Note that this role must be assumed by the 'lambda.amazonaws.com' service principal.

      This property cannot be used with 'role' property

      Default: - A default role will be created.

      Specified by:
      getFrameworkOnEventRole in interface ProviderProps

    • getIsCompleteHandler

      public final IFunction getIsCompleteHandler()
      Description copied from interface: ProviderProps
      The AWS Lambda function to invoke in order to determine if the operation is complete.

      This function will be called immediately after onEvent and then periodically based on the configured query interval as long as it returns false. If the function still returns false and the alloted timeout has passed, the operation will fail.

      Default: - provider is synchronous. This means that the `onEvent` handler is expected to finish all lifecycle operations within the initial invocation.

      Specified by:
      getIsCompleteHandler in interface ProviderProps

    • getLogGroup

      public final ILogGroup getLogGroup()
      Description copied from interface: ProviderProps
      The Log Group used for logging of events emitted by the custom resource's lambda function.

      Providing a user-controlled log group was rolled out to commercial regions on 2023-11-16. If you are deploying to another type of region, please check regional availability first.

      Default: - a default log group created by AWS Lambda

      Specified by:
      getLogGroup in interface ProviderProps

    • getLogRetention

      public final RetentionDays getLogRetention()
      Description copied from interface: ProviderProps
      The number of days framework log events are kept in CloudWatch Logs.

      When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to INFINITE.

      This is a legacy API and we strongly recommend you migrate to logGroup if you can. logGroup allows you to create a fully customizable log group and instruct the Lambda function to send logs to it.

      Default: logs.RetentionDays.INFINITE

      Specified by:
      getLogRetention in interface ProviderProps

    • getProviderFunctionEnvEncryption

      public final IKeyRef getProviderFunctionEnvEncryption()
      Description copied from interface: ProviderProps
      AWS KMS key used to encrypt provider lambda's environment variables.

      Default: - AWS Lambda creates and uses an AWS managed customer master key (CMK)

      Specified by:
      getProviderFunctionEnvEncryption in interface ProviderProps

    • getProviderFunctionName

      public final String getProviderFunctionName()
      Description copied from interface: ProviderProps
      Provider Lambda name.

      The provider lambda function name.

      Default: - CloudFormation default name from unique physical ID

      Specified by:
      getProviderFunctionName in interface ProviderProps

    • getQueryInterval

      public final Duration getQueryInterval()
      Description copied from interface: ProviderProps
      Time between calls to the isComplete handler which determines if the resource has been stabilized.

      The first isComplete will be called immediately after handler and then every queryInterval seconds, and until timeout has been reached or until isComplete returns true.

      Default: Duration.seconds(5)

      Specified by:
      getQueryInterval in interface ProviderProps

    • getRole

      public final IRole getRole()
      Description copied from interface: ProviderProps
      (deprecated) AWS Lambda execution role.

      The role is shared by provider framework's onEvent, isComplete lambda, and onTimeout Lambda functions. This role will be assumed by the AWS Lambda, so it must be assumable by the 'lambda.amazonaws.com' service principal.

      Default: - A default role will be created.

      Specified by:
      getRole in interface ProviderProps

    • getSecurityGroups

      public final List<ISecurityGroup> getSecurityGroups()
      Description copied from interface: ProviderProps
      Security groups to attach to the provider functions.

      Only used if 'vpc' is supplied

      Default: - If `vpc` is not supplied, no security groups are attached. Otherwise, a dedicated security group is created for each function.

      Specified by:
      getSecurityGroups in interface ProviderProps

    • getTotalTimeout

      public final Duration getTotalTimeout()
      Description copied from interface: ProviderProps
      Total timeout for the entire operation.

      The maximum timeout is 1 hour (yes, it can exceed the AWS Lambda 15 minutes)

      Default: Duration.minutes(30)

      Specified by:
      getTotalTimeout in interface ProviderProps

    • getVpc

      public final IVpc getVpc()
      Description copied from interface: ProviderProps
      The vpc to provision the lambda functions in.

      Default: - functions are not provisioned inside a vpc.

      Specified by:
      getVpc in interface ProviderProps

    • getVpcSubnets

      public final SubnetSelection getVpcSubnets()
      Description copied from interface: ProviderProps
      Which subnets from the VPC to place the lambda functions in.

      Only used if 'vpc' is supplied. Note: internet access for Lambdas requires a NAT gateway, so picking Public subnets is not allowed.

      Default: - the Vpc default strategy if not specified

      Specified by:
      getVpcSubnets in interface ProviderProps

    • getWaiterStateMachineLogOptions

      public final LogOptions getWaiterStateMachineLogOptions()
      Description copied from interface: ProviderProps
      Defines what execution history events of the waiter state machine are logged and where they are logged.

      Default: - A default log group will be created if logging for the waiter state machine is enabled.

      Specified by:
      getWaiterStateMachineLogOptions in interface ProviderProps

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