Package software.amazon.awscdk

Interface ResourceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

KeyPairProps

All Known Implementing Classes:

KeyPairProps.Jsii$Proxy, ResourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:02.238Z")
@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.*;
 ResourceProps resourceProps = ResourceProps.builder()
         .account("account")
         .environmentFromArn("environmentFromArn")
         .physicalName("physicalName")
         .region("region")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ResourceProps.Builder	A builder for ResourceProps
static final class	ResourceProps.Jsii$Proxy	An implementation for ResourceProps

Method Summary

Modifier and Type	Method	Description
static ResourceProps.Builder	builder()
default String	getAccount()	The AWS account ID this resource belongs to.
default String	getEnvironmentFromArn()	ARN to deduce region and account from.
default String	getPhysicalName()	The value passed in by users to the physical name prop of the resource.
default String	getRegion()	The AWS region this resource belongs to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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