Package software.amazon.awscdk.customresources

Class PhysicalResourceIdReference

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.customresources.PhysicalResourceIdReference

All Implemented Interfaces:

IResolvable, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-10-31T19:13:07.360Z")
@Stability(Stable)
public class PhysicalResourceIdReference
extends software.amazon.jsii.JsiiObject
implements IResolvable

Reference to the physical resource id that can be passed to the AWS operation as a parameter.

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();
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResolvable

IResolvable.Jsii$Default, IResolvable.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<String>	getCreationStack()	The creation stack of this resolvable which will be appended to errors thrown during resolution.
Object	resolve(IResolveContext _context)	Produce the Token's value at resolution time.
String	toJSON()	toJSON serialization to replace PhysicalResourceIdReference with a magic string.
String	toString()	Return a string representation of this resolvable object.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.IResolvable

getTypeHint

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

PhysicalResourceIdReference

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

PhysicalResourceIdReference

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

PhysicalResourceIdReference

@Stability(Stable)
public PhysicalResourceIdReference()

Method Details

resolve

@Stability(Stable)
@NotNull
public Object resolve(@NotNull
 IResolveContext _context)

Produce the Token's value at resolution time.

Specified by:

resolve in interface IResolvable

Parameters:

_context - This parameter is required.

toJSON

@Stability(Stable)
@NotNull
public String toJSON()

toJSON serialization to replace PhysicalResourceIdReference with a magic string.

toString

@Stability(Stable)
@NotNull
public String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Specified by:

toString in interface IResolvable

Overrides:

toString in class Object

getCreationStack

@Stability(Stable)
@NotNull
public List<String> getCreationStack()

The creation stack of this resolvable which will be appended to errors thrown during resolution.

This may return an array with a single informational element indicating how to get this property populated, if it was skipped for performance reasons.

Specified by:

getCreationStack in interface IResolvable