Class: AWSCDK::CustomResources::Provider

Inherits:
Constructs::Construct
  • Object
show all
Defined in:
custom_resources/provider.rb

Overview

Defines an AWS CloudFormation custom resource provider.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ Provider

Returns a new instance of Provider.

Parameters:



11
12
13
14
15
16
17
 
# File 'custom_resources/provider.rb', line 11

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::CustomResources::ProviderProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5jdXN0b21fcmVzb3VyY2VzLlByb3ZpZGVyUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



19
20
21
22
23
24
25
26
27
28
 
# File 'custom_resources/provider.rb', line 19

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :on_event_handler => { kind: :property, name: "onEventHandler", is_optional: false },
    :service_token => { kind: :property, name: "serviceToken", is_optional: false },
    :is_complete_handler => { kind: :property, name: "isCompleteHandler", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


40
41
42
 
# File 'custom_resources/provider.rb', line 40

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.custom_resources.Provider", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#is_complete_handler ⇒ AWSCDK::Lambda::IFunction?

The user-defined AWS Lambda function which is invoked asynchronously in order to determine if the operation is complete.

Returns:



61
62
63
 
# File 'custom_resources/provider.rb', line 61

def is_complete_handler()
  jsii_get_property("isCompleteHandler")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


33
34
35
 
# File 'custom_resources/provider.rb', line 33

def node()
  jsii_get_property("node")
end

#on_event_handler ⇒ AWSCDK::Lambda::IFunction

The user-defined AWS Lambda function which is invoked for all resource lifecycle operations (CREATE/UPDATE/DELETE).

Returns:



47
48
49
 
# File 'custom_resources/provider.rb', line 47

def on_event_handler()
  jsii_get_property("onEventHandler")
end

#service_token ⇒ String

The service token to use in order to define custom resources that are backed by this provider.

Returns:

  • (String) 


54
55
56
 
# File 'custom_resources/provider.rb', line 54

def service_token()
  jsii_get_property("serviceToken")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


68
69
70
 
# File 'custom_resources/provider.rb', line 68

def to_string()
  jsii_call_method("toString", [])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



81
82
83
84
85
86
 
# File 'custom_resources/provider.rb', line 81

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end