Class: AWSCDK::CustomResources::PhysicalResourceId

Inherits:
Jsii::Object
  • Object
show all
Defined in:
custom_resources/physical_resource_id.rb

Overview

Physical ID of the custom resource.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ PhysicalResourceId

Returns a new instance of PhysicalResourceId.

Raises:

  • (NoMethodError) 


8
9
10
 
# File 'custom_resources/physical_resource_id.rb', line 8

def initialize(*args)
  raise NoMethodError, "aws-cdk-lib.custom_resources.PhysicalResourceId does not have a visible constructor; use the provided factory methods"
end

Class Method Details

.from_response(response_path) ⇒ AWSCDK::CustomResources::PhysicalResourceId

Extract the physical resource id from the path (dot notation) to the data in the API call response.

Parameters:

  • response_path (String)

Returns:

  • (AWSCDK::CustomResources::PhysicalResourceId) 


23
24
25
26
 
# File 'custom_resources/physical_resource_id.rb', line 23

def self.from_response(response_path)
  Jsii::Type.check_type(response_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "responsePath")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.custom_resources.PhysicalResourceId", "fromResponse", [response_path])
end

.jsii_overridable_methods ⇒ Object 



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

def self.jsii_overridable_methods
  {
    :id => { kind: :property, name: "id", is_optional: true },
    :response_path => { kind: :property, name: "responsePath", is_optional: true },
  }
end

.of(id) ⇒ AWSCDK::CustomResources::PhysicalResourceId

Explicit physical resource id.

Parameters:

  • id (String)

Returns:

  • (AWSCDK::CustomResources::PhysicalResourceId) 


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

def self.of(id)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.custom_resources.PhysicalResourceId", "of", [id])
end

Instance Method Details

#id ⇒ String?

Literal string to be used as the physical id.

Returns:

  • (String, nil) 


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

def id()
  jsii_get_property("id")
end

#response_path ⇒ String?

Path to a response data element to be used as the physical id.

Returns:

  • (String, nil) 


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

def response_path()
  jsii_get_property("responsePath")
end