software.amazon.awscdk.services.refactorspaces

Class CfnApplication

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.refactorspaces.CfnApplication

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:39.487Z")
public class CfnApplication
extends CfnResource
implements IInspectable

A CloudFormation `AWS::RefactorSpaces::Application`.

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")
         .apiGatewayProxy(ApiGatewayProxyInputProperty.builder()
                 .endpointType("endpointType")
                 .stageName("stageName")
                 .build())
         .environmentIdentifier("environmentIdentifier")
         .name("name")
         .proxyType("proxyType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcId("vpcId")
         .build();
 

Nested Class Summary

Nested Classes

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

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnApplication(Construct scope, java.lang.String id) Create a new `AWS::RefactorSpaces::Application`.
	CfnApplication(Construct scope, java.lang.String id, CfnApplicationProps props) Create a new `AWS::RefactorSpaces::Application`.
protected	CfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApplication(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

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

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnApplication

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

CfnApplication

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

CfnApplication

public CfnApplication(Construct scope,
                      java.lang.String id,
                      CfnApplicationProps props)

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

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.

CfnApplication

public CfnApplication(Construct scope,
                      java.lang.String id)

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

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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrApiGatewayId

public java.lang.String getAttrApiGatewayId()

The resource ID of the API Gateway for the proxy.

getAttrApplicationIdentifier

public java.lang.String getAttrApplicationIdentifier()

The unique identifier of the application.

getAttrArn

public java.lang.String getAttrArn()

The Amazon Resource Name (ARN) of the application.

getAttrNlbArn

public java.lang.String getAttrNlbArn()

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

getAttrNlbName

public java.lang.String getAttrNlbName()

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

getAttrProxyUrl

public java.lang.String getAttrProxyUrl()

The endpoint URL of the Amazon API Gateway proxy.

getAttrStageName

public java.lang.String getAttrStageName()

The name of the API Gateway stage.

The name defaults to prod .

getAttrVpcLinkId

public java.lang.String getAttrVpcLinkId()

The `VpcLink` ID of the API Gateway proxy.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The tags assigned to the application.

getApiGatewayProxy

public java.lang.Object getApiGatewayProxy()

The endpoint URL of the Amazon API Gateway proxy.

setApiGatewayProxy

public void setApiGatewayProxy(CfnApplication.ApiGatewayProxyInputProperty value)

The endpoint URL of the Amazon API Gateway proxy.

setApiGatewayProxy

public void setApiGatewayProxy(IResolvable value)

The endpoint URL of the Amazon API Gateway proxy.

getEnvironmentIdentifier

public java.lang.String getEnvironmentIdentifier()

The unique identifier of the environment.

setEnvironmentIdentifier

public void setEnvironmentIdentifier(java.lang.String value)

The unique identifier of the environment.

getName

public java.lang.String getName()

The name of the application.

setName

public void setName(java.lang.String value)

The name of the application.

getProxyType

public java.lang.String getProxyType()

The proxy type of the proxy created within the application.

setProxyType

public void setProxyType(java.lang.String value)

The proxy type of the proxy created within the application.

getVpcId

public java.lang.String getVpcId()

The ID of the virtual private cloud (VPC).

setVpcId

public void setVpcId(java.lang.String value)

The ID of the virtual private cloud (VPC).