Class PhysicalResourceId

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.customresources.PhysicalResourceId
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-17T05:10:19.365Z") @Stability(Stable) public class PhysicalResourceId extends software.amazon.jsii.JsiiObject
Physical ID of the custom resource.

Example:

 AwsCustomResource getParameter = AwsCustomResource.Builder.create(this, "AssociateVPCWithHostedZone")
         .onCreate(AwsSdkCall.builder()
                 .assumedRoleArn("arn:aws:iam::OTHERACCOUNT:role/CrossAccount/ManageHostedZoneConnections")
                 .service("Route53")
                 .action("AssociateVPCWithHostedZone")
                 .parameters(Map.of(
                         "HostedZoneId", "hz-123",
                         "VPC", Map.of(
                                 "VPCId", "vpc-123",
                                 "VPCRegion", "region-for-vpc")))
                 .physicalResourceId(PhysicalResourceId.of("${vpcStack.SharedVpc.VpcId}-${vpcStack.Region}-${PrivateHostedZone.HostedZoneId}"))
                 .build())
         //Will ignore any resource and use the assumedRoleArn as resource and 'sts:AssumeRole' for service:action
         .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
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    PhysicalResourceId(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    PhysicalResourceId(software.amazon.jsii.JsiiObjectRef objRef)
     
  • Method Summary

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

    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, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson
  • Constructor Details

    • PhysicalResourceId

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

      protected PhysicalResourceId(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
  • Method Details

    • fromResponse

      @Stability(Stable) @NotNull public static PhysicalResourceId fromResponse(@NotNull 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

      @Stability(Stable) @NotNull public static PhysicalResourceId of(@NotNull String id)
      Explicit physical resource id.

      Parameters:
      id - This parameter is required.
    • getId

      @Stability(Stable) @Nullable public String getId()
      Literal string to be used as the physical id.
    • getResponsePath

      @Stability(Stable) @Nullable public String getResponsePath()
      Path to a response data element to be used as the physical id.