Package software.amazon.awscdk.cxapi

Interface Environment

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

Environment.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:54.721Z")
@Stability(Stable)
public interface Environment
extends software.amazon.jsii.JsiiSerializable

Models an AWS execution environment, for use within the CDK toolkit.

Example:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static Environment.Builder	builder()
String	getAccount()	The AWS account this environment deploys into.
String	getName()	The arbitrary name of this environment (user-set, or at least user-meaningful).
String	getRegion()	The AWS region name where this environment deploys into.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccount

@Stability(Stable)
@NotNull
String getAccount()

The AWS account this environment deploys into.

getName

@Stability(Stable)
@NotNull
String getName()

The arbitrary name of this environment (user-set, or at least user-meaningful).

getRegion

@Stability(Stable)
@NotNull
String getRegion()

The AWS region name where this environment deploys into.

builder

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

Returns:

a Environment.Builder of Environment