@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:39.487Z") public class CfnApplication extends CfnResource implements IInspectable
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();
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 . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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).
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnApplication(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnApplication(Construct scope, java.lang.String id, CfnApplicationProps props)
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.public CfnApplication(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrApiGatewayId()
public java.lang.String getAttrApplicationIdentifier()
public java.lang.String getAttrArn()
public java.lang.String getAttrNlbArn()
public java.lang.String getAttrNlbName()
public java.lang.String getAttrProxyUrl()
public java.lang.String getAttrStageName()
The name defaults to prod
.
public java.lang.String getAttrVpcLinkId()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.Object getApiGatewayProxy()
public void setApiGatewayProxy(CfnApplication.ApiGatewayProxyInputProperty value)
public void setApiGatewayProxy(IResolvable value)
public java.lang.String getEnvironmentIdentifier()
public void setEnvironmentIdentifier(java.lang.String value)
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.String getProxyType()
public void setProxyType(java.lang.String value)
public java.lang.String getVpcId()
public void setVpcId(java.lang.String value)