Skip to content
v2.278.0

CfnRouteProps Struct ​

Properties for defining a CfnRoute.

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 cfnRouteProps: refactorspaces.CfnRouteProps = {
  applicationIdentifier: 'applicationIdentifier',
  environmentIdentifier: 'environmentIdentifier',
  routeType: 'routeType',
  serviceIdentifier: 'serviceIdentifier',

  // the properties below are optional
  defaultRoute: {
    activationState: 'activationState',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  uriPathRoute: {
    activationState: 'activationState',

    // the properties below are optional
    appendSourcePath: false,
    includeChildPaths: false,
    methods: ['methods'],
    sourcePath: 'sourcePath',
  },
};
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_route_props = refactorspaces.CfnRouteProps(
    application_identifier="applicationIdentifier",
    environment_identifier="environmentIdentifier",
    route_type="routeType",
    service_identifier="serviceIdentifier",

    # the properties below are optional
    default_route=refactorspaces.CfnRoute.DefaultRouteInputProperty(
        activation_state="activationState"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    uri_path_route=refactorspaces.CfnRoute.UriPathRouteInputProperty(
        activation_state="activationState",

        # the properties below are optional
        append_source_path=False,
        include_child_paths=False,
        methods=["methods"],
        source_path="sourcePath"
    )
)
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.*;

CfnRouteProps cfnRouteProps = CfnRouteProps.builder()
        .applicationIdentifier("applicationIdentifier")
        .environmentIdentifier("environmentIdentifier")
        .routeType("routeType")
        .serviceIdentifier("serviceIdentifier")

        // the properties below are optional
        .defaultRoute(DefaultRouteInputProperty.builder()
                .activationState("activationState")
                .build())
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .uriPathRoute(UriPathRouteInputProperty.builder()
                .activationState("activationState")

                // the properties below are optional
                .appendSourcePath(false)
                .includeChildPaths(false)
                .methods(List.of("methods"))
                .sourcePath("sourcePath")
                .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 cfnRouteProps = new CfnRouteProps {
    ApplicationIdentifier = "applicationIdentifier",
    EnvironmentIdentifier = "environmentIdentifier",
    RouteType = "routeType",
    ServiceIdentifier = "serviceIdentifier",

    // the properties below are optional
    DefaultRoute = new DefaultRouteInputProperty {
        ActivationState = "activationState"
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    UriPathRoute = new UriPathRouteInputProperty {
        ActivationState = "activationState",

        // the properties below are optional
        AppendSourcePath = false,
        IncludeChildPaths = false,
        Methods = new [] { "methods" },
        SourcePath = "sourcePath"
    }
};
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"

cfnRouteProps := &CfnRouteProps{
	ApplicationIdentifier: jsii.String("applicationIdentifier"),
	EnvironmentIdentifier: jsii.String("environmentIdentifier"),
	RouteType: jsii.String("routeType"),
	ServiceIdentifier: jsii.String("serviceIdentifier"),

	// the properties below are optional
	DefaultRoute: &DefaultRouteInputProperty{
		ActivationState: jsii.String("activationState"),
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	UriPathRoute: &UriPathRouteInputProperty{
		ActivationState: jsii.String("activationState"),

		// the properties below are optional
		AppendSourcePath: jsii.Boolean(false),
		IncludeChildPaths: jsii.Boolean(false),
		Methods: []*string{
			jsii.String("methods"),
		},
		SourcePath: jsii.String("sourcePath"),
	},
}

Properties ​

applicationIdentifierstring | IApplicationRefapplication_identifiertyping.Union[str, IApplicationRef]applicationIdentifierStringApplicationIdentifierstringApplicationIdentifierinterface{} required #
The unique identifier of the application.
defaultRouteoptionalIResolvable | CfnRoute.DefaultRouteInputPropertydefault_routeoptionaltyping.Union[IResolvable, DefaultRouteInputProperty]defaultRouteoptionalIResolvableDefaultRouteoptionalIResolvableDefaultRouteoptionalinterface{} #
Configuration for the default route type.
environmentIdentifierstring | IEnvironmentRefenvironment_identifiertyping.Union[str, IEnvironmentRef]environmentIdentifierStringEnvironmentIdentifierstringEnvironmentIdentifierinterface{} required #
The unique identifier of the environment.
routeTypestringroute_typestrrouteTypeStringRouteTypestringRouteType*string required #
The route type of the route.
serviceIdentifierstring | IServiceRefservice_identifiertyping.Union[str, IServiceRef]serviceIdentifierStringServiceIdentifierstringServiceIdentifierinterface{} required #
The unique identifier of the service.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #
The tags assigned to the route.
uriPathRouteoptionalIResolvable | CfnRoute.UriPathRouteInputPropertyuri_path_routeoptionaltyping.Union[IResolvable, UriPathRouteInputProperty]uriPathRouteoptionalIResolvableUriPathRouteoptionalIResolvableUriPathRouteoptionalinterface{} #
The configuration for the URI path route type.