CfnServiceProps

class aws_cdk.aws_refactorspaces.CfnServiceProps(*, application_identifier, endpoint_type, environment_identifier, name, description=None, lambda_endpoint=None, tags=None, url_endpoint=None, vpc_id=None)

Bases: object

Properties for defining a CfnService.

Parameters:
  • application_identifier (str) – The unique identifier of the application.

  • endpoint_type (str) – The endpoint type of the service.

  • environment_identifier (str) – The unique identifier of the environment.

  • name (str) – The name of the service.

  • description (Optional[str]) – A description of the service.

  • lambda_endpoint (Union[IResolvable, LambdaEndpointInputProperty, Dict[str, Any], None]) – A summary of the configuration for the AWS Lambda endpoint type.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags assigned to the service.

  • url_endpoint (Union[IResolvable, UrlEndpointInputProperty, Dict[str, Any], None]) – The summary of the configuration for the URL endpoint type.

  • vpc_id (Optional[str]) – The ID of the virtual private cloud (VPC).

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

cfn_service_props = refactorspaces.CfnServiceProps(
    application_identifier="applicationIdentifier",
    endpoint_type="endpointType",
    environment_identifier="environmentIdentifier",
    name="name",

    # the properties below are optional
    description="description",
    lambda_endpoint=refactorspaces.CfnService.LambdaEndpointInputProperty(
        arn="arn"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    url_endpoint=refactorspaces.CfnService.UrlEndpointInputProperty(
        url="url",

        # the properties below are optional
        health_url="healthUrl"
    ),
    vpc_id="vpcId"
)

Attributes

application_identifier

The unique identifier of the application.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#cfn-refactorspaces-service-applicationidentifier

description

A description of the service.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#cfn-refactorspaces-service-description

endpoint_type

The endpoint type of the service.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#cfn-refactorspaces-service-endpointtype

environment_identifier

The unique identifier of the environment.

Link:

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

lambda_endpoint

A summary of the configuration for the AWS Lambda endpoint type.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#cfn-refactorspaces-service-lambdaendpoint

name

The name of the service.

Link:

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

tags

The tags assigned to the service.

Link:

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

url_endpoint

The summary of the configuration for the URL endpoint type.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-service.html#cfn-refactorspaces-service-urlendpoint

vpc_id

The ID of the virtual private cloud (VPC).

Link:

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