Package software.amazon.awscdk.services.refactorspaces

Class CfnApplication

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.CfnApplication

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-04-10T22:22:34.401Z")
@Stability(Stable)
public class CfnApplication
extends CfnResource
implements IInspectable, ITaggable

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 .

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.*;
 CfnApplication cfnApplication = CfnApplication.Builder.create(this, "MyCfnApplication")
         .environmentIdentifier("environmentIdentifier")
         .name("name")
         .proxyType("proxyType")
         .vpcId("vpcId")
         // the properties below are optional
         .apiGatewayProxy(ApiGatewayProxyInputProperty.builder()
                 .endpointType("endpointType")
                 .stageName("stageName")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-application.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnApplication.ApiGatewayProxyInputProperty	A wrapper object holding the Amazon API Gateway endpoint input.
static final class	CfnApplication.Builder	A fluent builder for CfnApplication.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApplication(software.amazon.jsii.JsiiObjectRef objRef)
	CfnApplication(software.constructs.Construct scope, String id, CfnApplicationProps props)

Method Summary

Modifier and Type	Method	Description
Object	getApiGatewayProxy()	The endpoint URL of the Amazon API Gateway proxy.
String	getAttrApiGatewayId()	The resource ID of the API Gateway for the proxy.
String	getAttrApplicationIdentifier()	The unique identifier of the application.
String	getAttrArn()	The Amazon Resource Name (ARN) of the application.
String	getAttrNlbArn()	The Amazon Resource Name (ARN) of the Network Load Balancer .
String	getAttrNlbName()	The name of the Network Load Balancer configured by the API Gateway proxy.
String	getAttrProxyUrl()	The endpoint URL of the Amazon API Gateway proxy.
String	getAttrStageName()	The name of the API Gateway stage.
String	getAttrVpcLinkId()	The VpcLink ID of the API Gateway proxy.
protected Map<String,Object>	getCfnProperties()
String	getEnvironmentIdentifier()	The unique identifier of the environment.
String	getName()	The name of the application.
String	getProxyType()	The proxy type of the proxy created within the application.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	The tags assigned to the application.
String	getVpcId()	The ID of the virtual private cloud (VPC).
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApiGatewayProxy(IResolvable value)	The endpoint URL of the Amazon API Gateway proxy.
void	setApiGatewayProxy(CfnApplication.ApiGatewayProxyInputProperty value)	The endpoint URL of the Amazon API Gateway proxy.
void	setEnvironmentIdentifier(String value)	The unique identifier of the environment.
void	setName(String value)	The name of the application.
void	setProxyType(String value)	The proxy type of the proxy created within the application.
void	setTagsRaw(List<CfnTag> value)	The tags assigned to the application.
void	setVpcId(String value)	The ID of the virtual private cloud (VPC).

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnApplication

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

CfnApplication

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

CfnApplication

@Stability(Stable)
public CfnApplication(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnApplicationProps props)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(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(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrApiGatewayId

@Stability(Stable)
@NotNull
public String getAttrApiGatewayId()

The resource ID of the API Gateway for the proxy.

getAttrApplicationIdentifier

@Stability(Stable)
@NotNull
public String getAttrApplicationIdentifier()

The unique identifier of the application.

getAttrArn

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

The Amazon Resource Name (ARN) of the application.

getAttrNlbArn

@Stability(Stable)
@NotNull
public String getAttrNlbArn()

The Amazon Resource Name (ARN) of the Network Load Balancer .

getAttrNlbName

@Stability(Stable)
@NotNull
public String getAttrNlbName()

The name of the Network Load Balancer configured by the API Gateway proxy.

getAttrProxyUrl

@Stability(Stable)
@NotNull
public String getAttrProxyUrl()

The endpoint URL of the Amazon API Gateway proxy.

getAttrStageName

@Stability(Stable)
@NotNull
public String getAttrStageName()

The name of the API Gateway stage.

The name defaults to prod .

getAttrVpcLinkId

@Stability(Stable)
@NotNull
public String getAttrVpcLinkId()

The VpcLink ID of the API Gateway proxy.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getEnvironmentIdentifier

@Stability(Stable)
@NotNull
public String getEnvironmentIdentifier()

The unique identifier of the environment.

setEnvironmentIdentifier

@Stability(Stable)
public void setEnvironmentIdentifier(@NotNull
 String value)

The unique identifier of the environment.

getName

@Stability(Stable)
@NotNull
public String getName()

The name of the application.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The name of the application.

getProxyType

@Stability(Stable)
@NotNull
public String getProxyType()

The proxy type of the proxy created within the application.

setProxyType

@Stability(Stable)
public void setProxyType(@NotNull
 String value)

The proxy type of the proxy created within the application.

getVpcId

@Stability(Stable)
@NotNull
public String getVpcId()

The ID of the virtual private cloud (VPC).

setVpcId

@Stability(Stable)
public void setVpcId(@NotNull
 String value)

The ID of the virtual private cloud (VPC).

getApiGatewayProxy

@Stability(Stable)
@Nullable
public Object getApiGatewayProxy()

The endpoint URL of the Amazon API Gateway proxy.

setApiGatewayProxy

@Stability(Stable)
public void setApiGatewayProxy(@Nullable
 IResolvable value)

The endpoint URL of the Amazon API Gateway proxy.

setApiGatewayProxy

@Stability(Stable)
public void setApiGatewayProxy(@Nullable
 CfnApplication.ApiGatewayProxyInputProperty value)

The endpoint URL of the Amazon API Gateway proxy.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

The tags assigned to the application.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

The tags assigned to the application.