Package software.amazon.awscdk.services.refactorspaces

Class CfnApplication

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:34.908Z") @Stability(Stable) 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")
         .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();

  • 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 Construct scope, @NotNull String id, @NotNull 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.
      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()
      The tags assigned to the application.

    • 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 CfnApplication.ApiGatewayProxyInputProperty value)
      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.