Package software.amazon.awscdk.services.refactorspaces

Interface CfnApplicationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApplicationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:16.689Z")
@Stability(Stable)
public interface CfnApplicationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnApplication.

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.*;
 CfnApplicationProps cfnApplicationProps = CfnApplicationProps.builder()
         .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	Interface	Description
static final class	CfnApplicationProps.Builder	A builder for CfnApplicationProps
static final class	CfnApplicationProps.Jsii$Proxy	An implementation for CfnApplicationProps

Method Summary

Modifier and Type	Method	Description
static CfnApplicationProps.Builder	builder()
default Object	getApiGatewayProxy()	The endpoint URL of the Amazon API Gateway proxy.
Object	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.
default List<CfnTag>	getTags()	The tags assigned to the application.
Object	getVpcId()	The ID of the virtual private cloud (VPC).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnvironmentIdentifier

@Stability(Stable)
@NotNull
Object getEnvironmentIdentifier()

The unique identifier of the environment.

Returns union: either String or IEnvironmentRef

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the application.

See Also:

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

getProxyType

@Stability(Stable)
@NotNull
String getProxyType()

The proxy type of the proxy created within the application.

See Also:

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

getVpcId

@Stability(Stable)
@NotNull
Object getVpcId()

The ID of the virtual private cloud (VPC).

Returns union: either String or IVPCRef

See Also:

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

getApiGatewayProxy

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

The endpoint URL of the Amazon API Gateway proxy.

Returns union: either IResolvable or CfnApplication.ApiGatewayProxyInputProperty

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags assigned to the application.

See Also:

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

builder

@Stability(Stable)
static CfnApplicationProps.Builder builder()

Returns:

a CfnApplicationProps.Builder of CfnApplicationProps