Interface ICfnGatewayRouteProps
Properties for defining a CfnGatewayRoute
.
Namespace: Amazon.CDK.AWS.AppMesh
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnGatewayRouteProps
Syntax (vb)
Public Interface ICfnGatewayRouteProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppMesh;
var cfnGatewayRouteProps = new CfnGatewayRouteProps {
MeshName = "meshName",
Spec = new GatewayRouteSpecProperty {
GrpcRoute = new GrpcGatewayRouteProperty {
Action = new GrpcGatewayRouteActionProperty {
Target = new GatewayRouteTargetProperty {
VirtualService = new GatewayRouteVirtualServiceProperty {
VirtualServiceName = "virtualServiceName"
},
// the properties below are optional
Port = 123
},
// the properties below are optional
Rewrite = new GrpcGatewayRouteRewriteProperty {
Hostname = new GatewayRouteHostnameRewriteProperty {
DefaultTargetHostname = "defaultTargetHostname"
}
}
},
Match = new GrpcGatewayRouteMatchProperty {
Hostname = new GatewayRouteHostnameMatchProperty {
Exact = "exact",
Suffix = "suffix"
},
Metadata = new [] { new GrpcGatewayRouteMetadataProperty {
Name = "name",
// the properties below are optional
Invert = false,
Match = new GatewayRouteMetadataMatchProperty {
Exact = "exact",
Prefix = "prefix",
Range = new GatewayRouteRangeMatchProperty {
End = 123,
Start = 123
},
Regex = "regex",
Suffix = "suffix"
}
} },
Port = 123,
ServiceName = "serviceName"
}
},
Http2Route = new HttpGatewayRouteProperty {
Action = new HttpGatewayRouteActionProperty {
Target = new GatewayRouteTargetProperty {
VirtualService = new GatewayRouteVirtualServiceProperty {
VirtualServiceName = "virtualServiceName"
},
// the properties below are optional
Port = 123
},
// the properties below are optional
Rewrite = new HttpGatewayRouteRewriteProperty {
Hostname = new GatewayRouteHostnameRewriteProperty {
DefaultTargetHostname = "defaultTargetHostname"
},
Path = new HttpGatewayRoutePathRewriteProperty {
Exact = "exact"
},
Prefix = new HttpGatewayRoutePrefixRewriteProperty {
DefaultPrefix = "defaultPrefix",
Value = "value"
}
}
},
Match = new HttpGatewayRouteMatchProperty {
Headers = new [] { new HttpGatewayRouteHeaderProperty {
Name = "name",
// the properties below are optional
Invert = false,
Match = new HttpGatewayRouteHeaderMatchProperty {
Exact = "exact",
Prefix = "prefix",
Range = new GatewayRouteRangeMatchProperty {
End = 123,
Start = 123
},
Regex = "regex",
Suffix = "suffix"
}
} },
Hostname = new GatewayRouteHostnameMatchProperty {
Exact = "exact",
Suffix = "suffix"
},
Method = "method",
Path = new HttpPathMatchProperty {
Exact = "exact",
Regex = "regex"
},
Port = 123,
Prefix = "prefix",
QueryParameters = new [] { new QueryParameterProperty {
Name = "name",
// the properties below are optional
Match = new HttpQueryParameterMatchProperty {
Exact = "exact"
}
} }
}
},
HttpRoute = new HttpGatewayRouteProperty {
Action = new HttpGatewayRouteActionProperty {
Target = new GatewayRouteTargetProperty {
VirtualService = new GatewayRouteVirtualServiceProperty {
VirtualServiceName = "virtualServiceName"
},
// the properties below are optional
Port = 123
},
// the properties below are optional
Rewrite = new HttpGatewayRouteRewriteProperty {
Hostname = new GatewayRouteHostnameRewriteProperty {
DefaultTargetHostname = "defaultTargetHostname"
},
Path = new HttpGatewayRoutePathRewriteProperty {
Exact = "exact"
},
Prefix = new HttpGatewayRoutePrefixRewriteProperty {
DefaultPrefix = "defaultPrefix",
Value = "value"
}
}
},
Match = new HttpGatewayRouteMatchProperty {
Headers = new [] { new HttpGatewayRouteHeaderProperty {
Name = "name",
// the properties below are optional
Invert = false,
Match = new HttpGatewayRouteHeaderMatchProperty {
Exact = "exact",
Prefix = "prefix",
Range = new GatewayRouteRangeMatchProperty {
End = 123,
Start = 123
},
Regex = "regex",
Suffix = "suffix"
}
} },
Hostname = new GatewayRouteHostnameMatchProperty {
Exact = "exact",
Suffix = "suffix"
},
Method = "method",
Path = new HttpPathMatchProperty {
Exact = "exact",
Regex = "regex"
},
Port = 123,
Prefix = "prefix",
QueryParameters = new [] { new QueryParameterProperty {
Name = "name",
// the properties below are optional
Match = new HttpQueryParameterMatchProperty {
Exact = "exact"
}
} }
}
},
Priority = 123
},
VirtualGatewayName = "virtualGatewayName",
// the properties below are optional
GatewayRouteName = "gatewayRouteName",
MeshOwner = "meshOwner",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Properties
GatewayRouteName | The name of the gateway route. |
MeshName | The name of the service mesh that the resource resides in. |
MeshOwner | The AWS IAM account ID of the service mesh owner. |
Spec | The specifications of the gateway route. |
Tags | Optional metadata that you can apply to the gateway route to assist with categorization and organization. |
VirtualGatewayName | The virtual gateway that the gateway route is associated with. |
Properties
GatewayRouteName
The name of the gateway route.
virtual string GatewayRouteName { get; }
Property Value
System.String
Remarks
MeshName
The name of the service mesh that the resource resides in.
string MeshName { get; }
Property Value
System.String
Remarks
MeshOwner
The AWS IAM account ID of the service mesh owner.
virtual string MeshOwner { get; }
Property Value
System.String
Remarks
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 .
Spec
The specifications of the gateway route.
object Spec { get; }
Property Value
System.Object
Remarks
Tags
Optional metadata that you can apply to the gateway route to assist with categorization and organization.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
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.
VirtualGatewayName
The virtual gateway that the gateway route is associated with.
string VirtualGatewayName { get; }
Property Value
System.String