software.amazon.awscdk.services.refactorspaces

Class CfnEnvironment

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.refactorspaces.CfnEnvironment

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.556Z")
 @Stability(value=Stable)
public class CfnEnvironment
extends CfnResource
implements IInspectable

A CloudFormation `AWS::RefactorSpaces::Environment`.

Creates an AWS Migration Hub Refactor Spaces environment. The caller owns the environment resource, and all Refactor Spaces applications, services, and routes created within the environment. They are referred to as the environment owner . The environment owner has cross-account visibility and control of Refactor Spaces resources that are added to the environment by other accounts that the environment is shared with. When creating an environment, Refactor Spaces provisions a transit gateway in your account.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.refactorspaces.*;
 CfnEnvironment cfnEnvironment = CfnEnvironment.Builder.create(this, "MyCfnEnvironment")
         .description("description")
         .name("name")
         .networkFabricType("networkFabricType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnEnvironment.Builder A fluent builder for CfnEnvironment.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEnvironment(software.constructs.Construct scope, String id) Create a new `AWS::RefactorSpaces::Environment`.
	CfnEnvironment(software.constructs.Construct scope, String id, CfnEnvironmentProps props) Create a new `AWS::RefactorSpaces::Environment`.
protected	CfnEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEnvironment(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) of the environment.
String	getAttrEnvironmentIdentifier() The unique identifier of the environment.
String	getAttrTransitGatewayId() The ID of the AWS Transit Gateway set up by the environment.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A description of the environment.
String	getName() The name of the environment.
String	getNetworkFabricType() The network fabric type of the environment.
TagManager	getTags() The tags assigned to the environment.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) A description of the environment.
void	setName(String value) The name of the environment.
void	setNetworkFabricType(String value) The network fabric type of the environment.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnEnvironment

protected CfnEnvironment(software.amazon.jsii.JsiiObjectRef objRef)

CfnEnvironment

protected CfnEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnEnvironment

@Stability(value=Stable)
public CfnEnvironment(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @Nullable
                                               CfnEnvironmentProps props)

Create a new `AWS::RefactorSpaces::Environment`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnEnvironment

@Stability(value=Stable)
public CfnEnvironment(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id)

Create a new `AWS::RefactorSpaces::Environment`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the environment.

getAttrEnvironmentIdentifier

@Stability(value=Stable)
 @NotNull
public String getAttrEnvironmentIdentifier()

The unique identifier of the environment.

getAttrTransitGatewayId

@Stability(value=Stable)
 @NotNull
public String getAttrTransitGatewayId()

The ID of the AWS Transit Gateway set up by the environment.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags assigned to the environment.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description of the environment.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description of the environment.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

The name of the environment.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name of the environment.

getNetworkFabricType

@Stability(value=Stable)
 @Nullable
public String getNetworkFabricType()

The network fabric type of the environment.

setNetworkFabricType

@Stability(value=Stable)
public void setNetworkFabricType(@Nullable
                                                          String value)

The network fabric type of the environment.