Package software.amazon.awscdk.core

Interface ResourceProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ResourceProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.105Z") @Stability(Stable) public interface ResourceProps extends software.amazon.jsii.JsiiSerializable
Construction properties for Resource.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.core.*;
 ResourceProps resourceProps = ResourceProps.builder()
         .account("account")
         .environmentFromArn("environmentFromArn")
         .physicalName("physicalName")
         .region("region")
         .build();

  • Method Details

    • getAccount

      @Stability(Stable) @Nullable default String getAccount()
      The AWS account ID this resource belongs to.

      Default: - the resource is in the same account as the stack it belongs to

    • getEnvironmentFromArn

      @Stability(Stable) @Nullable default String getEnvironmentFromArn()
      ARN to deduce region and account from.

      The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources.

      Cannot be supplied together with either account or region.

      Default: - take environment from `account`, `region` parameters, or use Stack environment.

    • getPhysicalName

      @Stability(Stable) @Nullable default String getPhysicalName()
      The value passed in by users to the physical name prop of the resource.

      • undefined implies that a physical name will be allocated by CloudFormation during deployment.
      • a concrete value implies a specific physical name
      • PhysicalName.GENERATE_IF_NEEDED is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.

      Default: - The physical name will be allocated by CloudFormation at deployment time

    • getRegion

      @Stability(Stable) @Nullable default String getRegion()
      The AWS region this resource belongs to.

      Default: - the resource is in the same region as the stack it belongs to

    • builder

      @Stability(Stable) static ResourceProps.Builder builder()
      Returns:
      a ResourceProps.Builder of ResourceProps