software.amazon.awscdk.core

Interface ResourceProps

All Known Implementing Classes:

ResourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-13T01:13:27.114Z")
public interface ResourceProps

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

getAccount

default java.lang.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

default java.lang.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

default java.lang.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

default java.lang.String getRegion()

The AWS region this resource belongs to.

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

builder

static ResourceProps.Builder builder()

Returns:

a ResourceProps.Builder of ResourceProps