@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-14T16:25:34.121Z")
public interface CfnGatewayRouteProps
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.appmesh.*;
CfnGatewayRouteProps cfnGatewayRouteProps = CfnGatewayRouteProps.builder()
.meshName("meshName")
.spec(GatewayRouteSpecProperty.builder()
.grpcRoute(GrpcGatewayRouteProperty.builder()
.action(GrpcGatewayRouteActionProperty.builder()
.target(GatewayRouteTargetProperty.builder()
.virtualService(GatewayRouteVirtualServiceProperty.builder()
.virtualServiceName("virtualServiceName")
.build())
// the properties below are optional
.port(123)
.build())
// the properties below are optional
.rewrite(GrpcGatewayRouteRewriteProperty.builder()
.hostname(GatewayRouteHostnameRewriteProperty.builder()
.defaultTargetHostname("defaultTargetHostname")
.build())
.build())
.build())
.match(GrpcGatewayRouteMatchProperty.builder()
.hostname(GatewayRouteHostnameMatchProperty.builder()
.exact("exact")
.suffix("suffix")
.build())
.metadata(List.of(GrpcGatewayRouteMetadataProperty.builder()
.name("name")
// the properties below are optional
.invert(false)
.match(GatewayRouteMetadataMatchProperty.builder()
.exact("exact")
.prefix("prefix")
.range(GatewayRouteRangeMatchProperty.builder()
.end(123)
.start(123)
.build())
.regex("regex")
.suffix("suffix")
.build())
.build()))
.port(123)
.serviceName("serviceName")
.build())
.build())
.http2Route(HttpGatewayRouteProperty.builder()
.action(HttpGatewayRouteActionProperty.builder()
.target(GatewayRouteTargetProperty.builder()
.virtualService(GatewayRouteVirtualServiceProperty.builder()
.virtualServiceName("virtualServiceName")
.build())
// the properties below are optional
.port(123)
.build())
// the properties below are optional
.rewrite(HttpGatewayRouteRewriteProperty.builder()
.hostname(GatewayRouteHostnameRewriteProperty.builder()
.defaultTargetHostname("defaultTargetHostname")
.build())
.path(HttpGatewayRoutePathRewriteProperty.builder()
.exact("exact")
.build())
.prefix(HttpGatewayRoutePrefixRewriteProperty.builder()
.defaultPrefix("defaultPrefix")
.value("value")
.build())
.build())
.build())
.match(HttpGatewayRouteMatchProperty.builder()
.headers(List.of(HttpGatewayRouteHeaderProperty.builder()
.name("name")
// the properties below are optional
.invert(false)
.match(HttpGatewayRouteHeaderMatchProperty.builder()
.exact("exact")
.prefix("prefix")
.range(GatewayRouteRangeMatchProperty.builder()
.end(123)
.start(123)
.build())
.regex("regex")
.suffix("suffix")
.build())
.build()))
.hostname(GatewayRouteHostnameMatchProperty.builder()
.exact("exact")
.suffix("suffix")
.build())
.method("method")
.path(HttpPathMatchProperty.builder()
.exact("exact")
.regex("regex")
.build())
.port(123)
.prefix("prefix")
.queryParameters(List.of(QueryParameterProperty.builder()
.name("name")
// the properties below are optional
.match(HttpQueryParameterMatchProperty.builder()
.exact("exact")
.build())
.build()))
.build())
.build())
.httpRoute(HttpGatewayRouteProperty.builder()
.action(HttpGatewayRouteActionProperty.builder()
.target(GatewayRouteTargetProperty.builder()
.virtualService(GatewayRouteVirtualServiceProperty.builder()
.virtualServiceName("virtualServiceName")
.build())
// the properties below are optional
.port(123)
.build())
// the properties below are optional
.rewrite(HttpGatewayRouteRewriteProperty.builder()
.hostname(GatewayRouteHostnameRewriteProperty.builder()
.defaultTargetHostname("defaultTargetHostname")
.build())
.path(HttpGatewayRoutePathRewriteProperty.builder()
.exact("exact")
.build())
.prefix(HttpGatewayRoutePrefixRewriteProperty.builder()
.defaultPrefix("defaultPrefix")
.value("value")
.build())
.build())
.build())
.match(HttpGatewayRouteMatchProperty.builder()
.headers(List.of(HttpGatewayRouteHeaderProperty.builder()
.name("name")
// the properties below are optional
.invert(false)
.match(HttpGatewayRouteHeaderMatchProperty.builder()
.exact("exact")
.prefix("prefix")
.range(GatewayRouteRangeMatchProperty.builder()
.end(123)
.start(123)
.build())
.regex("regex")
.suffix("suffix")
.build())
.build()))
.hostname(GatewayRouteHostnameMatchProperty.builder()
.exact("exact")
.suffix("suffix")
.build())
.method("method")
.path(HttpPathMatchProperty.builder()
.exact("exact")
.regex("regex")
.build())
.port(123)
.prefix("prefix")
.queryParameters(List.of(QueryParameterProperty.builder()
.name("name")
// the properties below are optional
.match(HttpQueryParameterMatchProperty.builder()
.exact("exact")
.build())
.build()))
.build())
.build())
.priority(123)
.build())
.virtualGatewayName("virtualGatewayName")
// the properties below are optional
.gatewayRouteName("gatewayRouteName")
.meshOwner("meshOwner")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
| Modifier and Type | Interface and Description |
|---|---|
static class |
CfnGatewayRouteProps.Builder
A builder for
CfnGatewayRouteProps |
static class |
CfnGatewayRouteProps.Jsii$Proxy
An implementation for
CfnGatewayRouteProps |
| Modifier and Type | Method and Description |
|---|---|
static CfnGatewayRouteProps.Builder |
builder() |
default java.lang.String |
getGatewayRouteName()
The name of the gateway route.
|
java.lang.String |
getMeshName()
The name of the service mesh that the resource resides in.
|
default java.lang.String |
getMeshOwner()
The AWS IAM account ID of the service mesh owner.
|
java.lang.Object |
getSpec()
The specifications of the gateway route.
|
default java.util.List<CfnTag> |
getTags()
Optional metadata that you can apply to the gateway route to assist with categorization and organization.
|
java.lang.String |
getVirtualGatewayName()
The virtual gateway that the gateway route is associated with.
|
java.lang.String getMeshName()
java.lang.Object getSpec()
java.lang.String getVirtualGatewayName()
default java.lang.String getGatewayRouteName()
default java.lang.String getMeshOwner()
If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
default java.util.List<CfnTag> getTags()
Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
static CfnGatewayRouteProps.Builder builder()
CfnGatewayRouteProps.Builder of CfnGatewayRouteProps