Class CfnEnvironment
A CloudFormation AWS::RefactorSpaces::Environment
.
Inherited Members
Namespace: Amazon.CDK.AWS.RefactorSpaces
Assembly: Amazon.CDK.AWS.RefactorSpaces.dll
Syntax (csharp)
public class CfnEnvironment : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnEnvironment
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 with a CreateEnvironment:NetworkFabricType of TRANSIT_GATEWAY
, Refactor Spaces provisions a transit gateway to enable services in VPCs to communicate directly across accounts. If CreateEnvironment:NetworkFabricType is NONE
, Refactor Spaces does not create a transit gateway and you must use your network infrastructure to route traffic to services with private URL endpoints.
CloudformationResource: AWS::RefactorSpaces::Environment
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.RefactorSpaces;
var cfnEnvironment = new CfnEnvironment(this, "MyCfnEnvironment", new CfnEnvironmentProps {
Name = "name",
NetworkFabricType = "networkFabricType",
// the properties below are optional
Description = "description",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnEnvironment(Construct, String, ICfnEnvironmentProps) | Create a new |
CfnEnvironment(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnEnvironment(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The Amazon Resource Name (ARN) of the environment. |
AttrEnvironmentIdentifier | The unique identifier of the environment. |
AttrTransitGatewayId | The ID of the AWS Transit Gateway set up by the environment. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | A description of the environment. |
Name | The name of the environment. |
NetworkFabricType | The network fabric type of the environment. |
Tags | The tags assigned to the environment. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnEnvironment(Construct, String, ICfnEnvironmentProps)
Create a new AWS::RefactorSpaces::Environment
.
public CfnEnvironment(Construct scope, string id, ICfnEnvironmentProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnEnvironmentProps
- resource properties.
CfnEnvironment(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnEnvironment(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnEnvironment(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnEnvironment(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The Amazon Resource Name (ARN) of the environment.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrEnvironmentIdentifier
The unique identifier of the environment.
public virtual string AttrEnvironmentIdentifier { get; }
Property Value
System.String
Remarks
CloudformationAttribute: EnvironmentIdentifier
AttrTransitGatewayId
The ID of the AWS Transit Gateway set up by the environment.
public virtual string AttrTransitGatewayId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: TransitGatewayId
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
A description of the environment.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
Name
The name of the environment.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
NetworkFabricType
The network fabric type of the environment.
public virtual string NetworkFabricType { get; set; }
Property Value
System.String
Remarks
Tags
The tags assigned to the environment.
public virtual TagManager Tags { get; }
Property Value
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>