Class CfnApplication
A CloudFormation AWS::RefactorSpaces::Application
.
Inherited Members
Namespace: Amazon.CDK.AWS.RefactorSpaces
Assembly: Amazon.CDK.AWS.RefactorSpaces.dll
Syntax (csharp)
public class CfnApplication : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnApplication
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates an AWS Migration Hub Refactor Spaces application. The account that owns the environment also owns the applications created inside the environment, regardless of the account that creates the application. Refactor Spaces provisions an Amazon API Gateway , API Gateway VPC link, and Network Load Balancer for the application proxy inside your account.
In environments created with a CreateEnvironment:NetworkFabricType of NONE
you need to configure VPC to VPC connectivity between your service VPC and the application proxy VPC to route traffic through the application proxy to a service with a private URL endpoint. For more information, see Create an application in the Refactor Spaces User Guide .
CloudformationResource: AWS::RefactorSpaces::Application
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 cfnApplication = new CfnApplication(this, "MyCfnApplication", new CfnApplicationProps {
EnvironmentIdentifier = "environmentIdentifier",
Name = "name",
ProxyType = "proxyType",
VpcId = "vpcId",
// the properties below are optional
ApiGatewayProxy = new ApiGatewayProxyInputProperty {
EndpointType = "endpointType",
StageName = "stageName"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnApplication(Construct, String, ICfnApplicationProps) | Create a new |
CfnApplication(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnApplication(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
ApiGatewayProxy | The endpoint URL of the Amazon API Gateway proxy. |
AttrApiGatewayId | The resource ID of the API Gateway for the proxy. |
AttrApplicationIdentifier | The unique identifier of the application. |
AttrArn | The Amazon Resource Name (ARN) of the application. |
AttrNlbArn | The Amazon Resource Name (ARN) of the Network Load Balancer . |
AttrNlbName | The name of the Network Load Balancer configured by the API Gateway proxy. |
AttrProxyUrl | The endpoint URL of the Amazon API Gateway proxy. |
AttrStageName | The name of the API Gateway stage. |
AttrVpcLinkId | The |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
EnvironmentIdentifier | The unique identifier of the environment. |
Name | The name of the application. |
ProxyType | The proxy type of the proxy created within the application. |
Tags | The tags assigned to the application. |
VpcId | The ID of the virtual private cloud (VPC). |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnApplication(Construct, String, ICfnApplicationProps)
Create a new AWS::RefactorSpaces::Application
.
public CfnApplication(Construct scope, string id, ICfnApplicationProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnApplicationProps
- resource properties.
CfnApplication(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnApplication(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnApplication(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnApplication(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
ApiGatewayProxy
The endpoint URL of the Amazon API Gateway proxy.
public virtual object ApiGatewayProxy { get; set; }
Property Value
System.Object
Remarks
AttrApiGatewayId
The resource ID of the API Gateway for the proxy.
public virtual string AttrApiGatewayId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ApiGatewayId
AttrApplicationIdentifier
The unique identifier of the application.
public virtual string AttrApplicationIdentifier { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ApplicationIdentifier
AttrArn
The Amazon Resource Name (ARN) of the application.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrNlbArn
The Amazon Resource Name (ARN) of the Network Load Balancer .
public virtual string AttrNlbArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: NlbArn
AttrNlbName
The name of the Network Load Balancer configured by the API Gateway proxy.
public virtual string AttrNlbName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: NlbName
AttrProxyUrl
The endpoint URL of the Amazon API Gateway proxy.
public virtual string AttrProxyUrl { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ProxyUrl
AttrStageName
The name of the API Gateway stage.
public virtual string AttrStageName { get; }
Property Value
System.String
Remarks
The name defaults to prod
.
CloudformationAttribute: StageName
AttrVpcLinkId
The VpcLink
ID of the API Gateway proxy.
public virtual string AttrVpcLinkId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: VpcLinkId
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
EnvironmentIdentifier
The unique identifier of the environment.
public virtual string EnvironmentIdentifier { get; set; }
Property Value
System.String
Remarks
Name
The name of the application.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
ProxyType
The proxy type of the proxy created within the application.
public virtual string ProxyType { get; set; }
Property Value
System.String
Remarks
Tags
The tags assigned to the application.
public virtual TagManager Tags { get; }
Property Value
Remarks
VpcId
The ID of the virtual private cloud (VPC).
public virtual string VpcId { get; set; }
Property Value
System.String
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>