Skip to content
v2.278.0

CfnApplicationProps Struct ​

Properties for defining a CfnApplication.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_refactorspaces as refactorspaces } from 'aws-cdk-lib';
const cfnApplicationProps: refactorspaces.CfnApplicationProps = {
  environmentIdentifier: 'environmentIdentifier',
  name: 'name',
  proxyType: 'proxyType',
  vpcId: 'vpcId',

  // the properties below are optional
  apiGatewayProxy: {
    endpointType: 'endpointType',
    stageName: 'stageName',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_refactorspaces as refactorspaces

cfn_application_props = refactorspaces.CfnApplicationProps(
    environment_identifier="environmentIdentifier",
    name="name",
    proxy_type="proxyType",
    vpc_id="vpcId",

    # the properties below are optional
    api_gateway_proxy=refactorspaces.CfnApplication.ApiGatewayProxyInputProperty(
        endpoint_type="endpointType",
        stage_name="stageName"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.RefactorSpaces;

var cfnApplicationProps = new CfnApplicationProps {
    EnvironmentIdentifier = "environmentIdentifier",
    Name = "name",
    ProxyType = "proxyType",
    VpcId = "vpcId",

    // the properties below are optional
    ApiGatewayProxy = new ApiGatewayProxyInputProperty {
        EndpointType = "endpointType",
        StageName = "stageName"
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnApplicationProps := &CfnApplicationProps{
	EnvironmentIdentifier: jsii.String("environmentIdentifier"),
	Name: jsii.String("name"),
	ProxyType: jsii.String("proxyType"),
	VpcId: jsii.String("vpcId"),

	// the properties below are optional
	ApiGatewayProxy: &ApiGatewayProxyInputProperty{
		EndpointType: jsii.String("endpointType"),
		StageName: jsii.String("stageName"),
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

apiGatewayProxyoptionalIResolvable | CfnApplication.ApiGatewayProxyInputPropertyapi_gateway_proxyoptionaltyping.Union[IResolvable, ApiGatewayProxyInputProperty]apiGatewayProxyoptionalIResolvableApiGatewayProxyoptionalIResolvableApiGatewayProxyoptionalinterface{} #
The endpoint URL of the Amazon API Gateway proxy.
environmentIdentifierstring | IEnvironmentRefenvironment_identifiertyping.Union[str, IEnvironmentRef]environmentIdentifierStringEnvironmentIdentifierstringEnvironmentIdentifierinterface{} required #
The unique identifier of the environment.
namestringnamestrnameStringNamestringName*string required #
The name of the application.
proxyTypestringproxy_typestrproxyTypeStringProxyTypestringProxyType*string required #
The proxy type of the proxy created within the application.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #
The tags assigned to the application.
vpcIdstring | IVPCRefvpc_idtyping.Union[str, IVPCRef]vpcIdStringVpcIdstringVpcIdinterface{} required #
The ID of the virtual private cloud (VPC).