CfnServicePropsMixin

class aws_cdk.mixins_preview.aws_refactorspaces.mixins.CfnServicePropsMixin(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 service. The account owner of the service is always the environment owner, regardless of which account in the environment creates the service. Services have either a URL endpoint in a virtual private cloud (VPC), or a Lambda function endpoint. .. epigraph:

If an AWS resource is launched in a service VPC, and you want it to be accessible to all of an environment’s services with VPCs and routes, apply the ``RefactorSpacesSecurityGroup`` to the resource. Alternatively, to add more cross-account constraints, apply your own security group.

see:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html
cloudformationResource:: AWS::RefactorSpaces::Service
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_service_props_mixin = refactorspaces_mixins.CfnServicePropsMixin(refactorspaces_mixins.CfnServiceMixinProps(
    application_identifier="applicationIdentifier",
    description="description",
    endpoint_type="endpointType",
    environment_identifier="environmentIdentifier",
    lambda_endpoint=refactorspaces_mixins.CfnServicePropsMixin.LambdaEndpointInputProperty(
        arn="arn"
    ),
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    url_endpoint=refactorspaces_mixins.CfnServicePropsMixin.UrlEndpointInputProperty(
        health_url="healthUrl",
        url="url"
    ),
    vpc_id="vpcId"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnServiceMixinProps, 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 = ['applicationIdentifier', 'description', 'endpointType', 'environmentIdentifier', 'lambdaEndpoint', 'name', 'tags', 'urlEndpoint', '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

LambdaEndpointInputProperty

class CfnServicePropsMixin.LambdaEndpointInputProperty(*, arn=None)

Bases: object

The input for the AWS Lambda endpoint type.

Parameters:: arn (Optional[str]) – The Amazon Resource Name (ARN) of the Lambda function or alias.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-service-lambdaendpointinput.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

lambda_endpoint_input_property = refactorspaces_mixins.CfnServicePropsMixin.LambdaEndpointInputProperty(
    arn="arn"
)

Attributes

arn

The Amazon Resource Name (ARN) of the Lambda function or alias.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-service-lambdaendpointinput.html#cfn-refactorspaces-service-lambdaendpointinput-arn

UrlEndpointInputProperty

class CfnServicePropsMixin.UrlEndpointInputProperty(*, health_url=None, url=None)

Bases: object

The configuration for the URL endpoint type.

Parameters:

health_url (Optional[str]) – The health check URL of the URL endpoint type. If the URL is a public endpoint, the HealthUrl must also be a public endpoint. If the URL is a private endpoint inside a virtual private cloud (VPC), the health URL must also be a private endpoint, and the host must be the same as the URL.
url (Optional[str]) – The URL to route traffic to. The URL must be an rfc3986-formatted URL . If the host is a domain name, the name must be resolvable over the public internet. If the scheme is https , the top level domain of the host must be listed in the IANA root zone database .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-service-urlendpointinput.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

url_endpoint_input_property = refactorspaces_mixins.CfnServicePropsMixin.UrlEndpointInputProperty(
    health_url="healthUrl",
    url="url"
)

Attributes

health_url

The health check URL of the URL endpoint type.

If the URL is a public endpoint, the HealthUrl must also be a public endpoint. If the URL is a private endpoint inside a virtual private cloud (VPC), the health URL must also be a private endpoint, and the host must be the same as the URL.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-service-urlendpointinput.html#cfn-refactorspaces-service-urlendpointinput-healthurl

url

The URL to route traffic to.

The URL must be an rfc3986-formatted URL . If the host is a domain name, the name must be resolvable over the public internet. If the scheme is https , the top level domain of the host must be listed in the IANA root zone database .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-service-urlendpointinput.html#cfn-refactorspaces-service-urlendpointinput-url