software.amazon.awscdk.customresources

Class PhysicalResourceId

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.customresources.PhysicalResourceId

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:45.242Z")
public class PhysicalResourceId
extends software.amazon.jsii.JsiiObject

Physical ID of the custom resource.

Example:

 AwsCustomResource awsCustom = AwsCustomResource.Builder.create(this, "aws-custom")
         .onCreate(AwsSdkCall.builder()
                 .service("...")
                 .action("...")
                 .parameters(Map.of(
                         "text", "..."))
                 .physicalResourceId(PhysicalResourceId.of("..."))
                 .build())
         .onUpdate(AwsSdkCall.builder()
                 .service("...")
                 .action("...")
                 .parameters(Map.of(
                         "text", "...",
                         "resourceId", new PhysicalResourceIdReference()))
                 .build())
         .policy(AwsCustomResourcePolicy.fromSdkCalls(SdkCallsPolicyOptions.builder()
                 .resources(AwsCustomResourcePolicy.ANY_RESOURCE)
                 .build()))
         .build();
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PhysicalResourceId(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	PhysicalResourceId(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static PhysicalResourceId	fromResponse(java.lang.String responsePath) Extract the physical resource id from the path (dot notation) to the data in the API call response.
java.lang.String	getId() Literal string to be used as the physical id.
java.lang.String	getResponsePath() Path to a response data element to be used as the physical id.
static PhysicalResourceId	of(java.lang.String id) Explicit physical resource id.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PhysicalResourceId

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

PhysicalResourceId

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

Method Detail

fromResponse

public static PhysicalResourceId fromResponse(java.lang.String responsePath)

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

Parameters:

responsePath - This parameter is required.

of

public static PhysicalResourceId of(java.lang.String id)

Explicit physical resource id.

Parameters:

id - This parameter is required.

getId

public java.lang.String getId()

Literal string to be used as the physical id.

getResponsePath

public java.lang.String getResponsePath()

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