Class CfnGatewayRoute
A CloudFormation AWS::AppMesh::GatewayRoute
.
Inherited Members
Namespace: Amazon.CDK.AWS.AppMesh
Assembly: Amazon.CDK.AWS.AppMesh.dll
Syntax (csharp)
public class CfnGatewayRoute : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnGatewayRoute
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates a gateway route.
A gateway route is attached to a virtual gateway and routes traffic to an existing virtual service. If a route matches a request, it can distribute traffic to a target virtual service.
For more information about gateway routes, see Gateway routes .
CloudformationResource: AWS::AppMesh::GatewayRoute
Link: 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 cfnGatewayRoute = new CfnGatewayRoute(this, "MyCfnGatewayRoute", 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
Constructors
CfnGatewayRoute(Construct, String, ICfnGatewayRouteProps) | Create a new |
CfnGatewayRoute(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnGatewayRoute(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The full Amazon Resource Name (ARN) for the gateway route. |
AttrGatewayRouteName | The name of the gateway route. |
AttrMeshName | The name of the service mesh that the gateway route resides in. |
AttrMeshOwner | The AWS IAM account ID of the service mesh owner. |
AttrResourceOwner | The IAM account ID of the resource owner. |
AttrUid | The unique identifier for the gateway route. |
AttrVirtualGatewayName | The name of the virtual gateway that the gateway route is associated with. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnGatewayRoute(Construct, String, ICfnGatewayRouteProps)
Create a new AWS::AppMesh::GatewayRoute
.
public CfnGatewayRoute(Construct scope, string id, ICfnGatewayRouteProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnGatewayRouteProps
- resource properties.
CfnGatewayRoute(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnGatewayRoute(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnGatewayRoute(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnGatewayRoute(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The full Amazon Resource Name (ARN) for the gateway route.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrGatewayRouteName
The name of the gateway route.
public virtual string AttrGatewayRouteName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: GatewayRouteName
AttrMeshName
The name of the service mesh that the gateway route resides in.
public virtual string AttrMeshName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: MeshName
AttrMeshOwner
The AWS IAM account ID of the service mesh owner.
public virtual string AttrMeshOwner { 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 .
CloudformationAttribute: MeshOwner
AttrResourceOwner
The IAM account ID of the resource owner.
public virtual string AttrResourceOwner { get; }
Property Value
System.String
Remarks
If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with Shared Meshes .
CloudformationAttribute: ResourceOwner
AttrUid
The unique identifier for the gateway route.
public virtual string AttrUid { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Uid
AttrVirtualGatewayName
The name of the virtual gateway that the gateway route is associated with.
public virtual string AttrVirtualGatewayName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: VirtualGatewayName
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
GatewayRouteName
The name of the gateway route.
public virtual string GatewayRouteName { get; set; }
Property Value
System.String
Remarks
MeshName
The name of the service mesh that the resource resides in.
public virtual string MeshName { get; set; }
Property Value
System.String
Remarks
MeshOwner
The AWS IAM account ID of the service mesh owner.
public virtual string MeshOwner { get; set; }
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.
public virtual object Spec { get; set; }
Property Value
System.Object
Remarks
Tags
Optional metadata that you can apply to the gateway route to assist with categorization and organization.
public virtual TagManager Tags { get; }
Property Value
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.
public virtual string VirtualGatewayName { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>