CfnApplicationPropsMixin

class aws_cdk.mixins_preview.aws_refactorspaces.mixins.CfnApplicationPropsMixin(props, *, strategy=None)

Bases: Mixin

AWS Migration Hub is no longer open to new customers as of November 7, 2025.

For capabilities similar to AWS Migration Hub , explore AWS Migration Hub .

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 .

see:

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

cloudformationResource:

AWS::RefactorSpaces::Application

mixin:

true

exampleMetadata:

fixture=_generated

Example:
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_refactorspaces import mixins as refactorspaces_mixins

cfn_application_props_mixin = refactorspaces_mixins.CfnApplicationPropsMixin(refactorspaces_mixins.CfnApplicationMixinProps(
    api_gateway_proxy=refactorspaces_mixins.CfnApplicationPropsMixin.ApiGatewayProxyInputProperty(
        endpoint_type="endpointType",
        stage_name="stageName"
    ),
    environment_identifier="environmentIdentifier",
    name="name",
    proxy_type="proxyType",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc_id="vpcId"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::RefactorSpaces::Application.

Parameters:

props (Union[CfnApplicationMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['apiGatewayProxy', 'environmentIdentifier', 'name', 'proxyType', 'tags', 'vpcId']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ApiGatewayProxyInputProperty

class CfnApplicationPropsMixin.ApiGatewayProxyInputProperty(*, endpoint_type=None, stage_name=None)

Bases: object

A wrapper object holding the Amazon API Gateway endpoint input.

Parameters:

endpoint_type (Optional[str]) – The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default. If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API Gateway that has been granted access. For more information about creating a private connection with Refactor Spaces and interface endpoint ( AWS PrivateLink ) availability, see Access Refactor Spaces using an interface endpoint ( AWS PrivateLink ) .
stage_name (Optional[str]) – The name of the API Gateway stage. The name defaults to prod .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-application-apigatewayproxyinput.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_refactorspaces import mixins as refactorspaces_mixins

api_gateway_proxy_input_property = refactorspaces_mixins.CfnApplicationPropsMixin.ApiGatewayProxyInputProperty(
    endpoint_type="endpointType",
    stage_name="stageName"
)

Attributes

endpoint_type

The type of endpoint to use for the API Gateway proxy.

If no value is specified in the request, the value is set to REGIONAL by default.

If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API Gateway that has been granted access. For more information about creating a private connection with Refactor Spaces and interface endpoint ( AWS PrivateLink ) availability, see Access Refactor Spaces using an interface endpoint ( AWS PrivateLink ) .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-application-apigatewayproxyinput.html#cfn-refactorspaces-application-apigatewayproxyinput-endpointtype

stage_name

The name of the API Gateway stage.

The name defaults to prod .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-application-apigatewayproxyinput.html#cfn-refactorspaces-application-apigatewayproxyinput-stagename