Package software.amazon.awscdk.services.refactorspaces

Interface CfnRouteProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRouteProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:12.822Z")
@Stability(Stable)
public interface CfnRouteProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRoute.

Example:

 // 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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRouteProps.Builder	A builder for CfnRouteProps
static final class	CfnRouteProps.Jsii$Proxy	An implementation for CfnRouteProps

Method Summary

Modifier and Type	Method	Description
static CfnRouteProps.Builder	builder()
String	getApplicationIdentifier()	The unique identifier of the application.
default Object	getDefaultRoute()	Configuration for the default route type.
String	getEnvironmentIdentifier()	The unique identifier of the environment.
String	getRouteType()	The route type of the route.
String	getServiceIdentifier()	The unique identifier of the service.
default List<CfnTag>	getTags()	The tags assigned to the route.
default Object	getUriPathRoute()	The configuration for the URI path route type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplicationIdentifier

@Stability(Stable)
@NotNull
String getApplicationIdentifier()

The unique identifier of the application.

See Also:

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

getEnvironmentIdentifier

@Stability(Stable)
@NotNull
String getEnvironmentIdentifier()

The unique identifier of the environment.

See Also:

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

getRouteType

@Stability(Stable)
@NotNull
String getRouteType()

The route type of the route.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-route.html#cfn-refactorspaces-route-routetype

getServiceIdentifier

@Stability(Stable)
@NotNull
String getServiceIdentifier()

The unique identifier of the service.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-route.html#cfn-refactorspaces-route-serviceidentifier

getDefaultRoute

@Stability(Stable)
@Nullable
default Object getDefaultRoute()

Configuration for the default route type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-route.html#cfn-refactorspaces-route-defaultroute

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags assigned to the route.

See Also:

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

getUriPathRoute

@Stability(Stable)
@Nullable
default Object getUriPathRoute()

The configuration for the URI path route type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-refactorspaces-route.html#cfn-refactorspaces-route-uripathroute

builder

@Stability(Stable)
static CfnRouteProps.Builder builder()

Returns:

a CfnRouteProps.Builder of CfnRouteProps