Package software.amazon.awscdk

Interface ResourceEnvironment

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ResourceEnvironment.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-06T14:43:12.996Z")
@Stability(Stable)
public interface ResourceEnvironment
extends software.amazon.jsii.JsiiSerializable

Represents the environment a given resource lives in.

Used as the return value for the IResource.env property.

Example:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ResourceEnvironment.Builder	builder()
String	getAccount()	The AWS account ID that this resource belongs to.
String	getRegion()	The AWS region that this resource belongs to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccount

@Stability(Stable)
@NotNull
String getAccount()

The AWS account ID that this resource belongs to.

Since this can be a Token (for example, when the account is CloudFormation's AWS::AccountId intrinsic), make sure to use Token.compareStrings() instead of just comparing the values for equality.

getRegion

@Stability(Stable)
@NotNull
String getRegion()

The AWS region that this resource belongs to.

Since this can be a Token (for example, when the region is CloudFormation's AWS::Region intrinsic), make sure to use Token.compareStrings() instead of just comparing the values for equality.

builder

@Stability(Stable)
static ResourceEnvironment.Builder builder()

Returns:

a ResourceEnvironment.Builder of ResourceEnvironment