UNPKG

aws-cdk-lib

Version:

Version 2 of the AWS Cloud Development Kit library

1,068 lines (1,067 loc) 218 kB
import * as cdk from "../../core"; import * as constructs from "constructs"; import * as cfn_parse from "../../core/lib/helpers-internal"; /** * 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](https://docs.aws.amazon.com/app-mesh/latest/userguide/gateway-routes.html) . * * @cloudformationResource AWS::AppMesh::GatewayRoute * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html */ export declare class CfnGatewayRoute extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnGatewayRoute from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnGatewayRoute; /** * The full Amazon Resource Name (ARN) for the gateway route. * * @cloudformationAttribute Arn */ readonly attrArn: string; /** * The name of the gateway route. * * @cloudformationAttribute GatewayRouteName */ readonly attrGatewayRouteName: string; /** * @cloudformationAttribute Id */ readonly attrId: string; /** * The name of the service mesh that the gateway route resides in. * * @cloudformationAttribute MeshName */ readonly attrMeshName: string; /** * The AWS IAM account ID of the service mesh owner. 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](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) . * * @cloudformationAttribute MeshOwner */ readonly attrMeshOwner: string; /** * The IAM account ID of the resource owner. 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](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) . * * @cloudformationAttribute ResourceOwner */ readonly attrResourceOwner: string; /** * The unique identifier for the gateway route. * * @cloudformationAttribute Uid */ readonly attrUid: string; /** * The name of the virtual gateway that the gateway route is associated with. * * @cloudformationAttribute VirtualGatewayName */ readonly attrVirtualGatewayName: string; /** * The name of the gateway route. */ gatewayRouteName?: string; /** * The name of the service mesh that the resource resides in. */ meshName: string; /** * The AWS IAM account ID of the service mesh owner. */ meshOwner?: string; /** * The specifications of the gateway route. */ spec: CfnGatewayRoute.GatewayRouteSpecProperty | cdk.IResolvable; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * Optional metadata that you can apply to the gateway route to assist with categorization and organization. */ tagsRaw?: Array<cdk.CfnTag>; /** * The virtual gateway that the gateway route is associated with. */ virtualGatewayName: string; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnGatewayRouteProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnGatewayRoute { /** * An object that represents a gateway route specification. * * Specify one gateway route type. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutespec.html */ interface GatewayRouteSpecProperty { /** * An object that represents the specification of a gRPC gateway route. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutespec.html#cfn-appmesh-gatewayroute-gatewayroutespec-grpcroute */ readonly grpcRoute?: CfnGatewayRoute.GrpcGatewayRouteProperty | cdk.IResolvable; /** * An object that represents the specification of an HTTP/2 gateway route. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutespec.html#cfn-appmesh-gatewayroute-gatewayroutespec-http2route */ readonly http2Route?: CfnGatewayRoute.HttpGatewayRouteProperty | cdk.IResolvable; /** * An object that represents the specification of an HTTP gateway route. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutespec.html#cfn-appmesh-gatewayroute-gatewayroutespec-httproute */ readonly httpRoute?: CfnGatewayRoute.HttpGatewayRouteProperty | cdk.IResolvable; /** * The ordering of the gateway routes spec. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutespec.html#cfn-appmesh-gatewayroute-gatewayroutespec-priority */ readonly priority?: number; } /** * An object that represents an HTTP gateway route. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroute.html */ interface HttpGatewayRouteProperty { /** * An object that represents the action to take if a match is determined. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroute.html#cfn-appmesh-gatewayroute-httpgatewayroute-action */ readonly action: CfnGatewayRoute.HttpGatewayRouteActionProperty | cdk.IResolvable; /** * An object that represents the criteria for determining a request match. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroute.html#cfn-appmesh-gatewayroute-httpgatewayroute-match */ readonly match: CfnGatewayRoute.HttpGatewayRouteMatchProperty | cdk.IResolvable; } /** * An object that represents the action to take if a match is determined. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteaction.html */ interface HttpGatewayRouteActionProperty { /** * The gateway route action to rewrite. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteaction.html#cfn-appmesh-gatewayroute-httpgatewayrouteaction-rewrite */ readonly rewrite?: CfnGatewayRoute.HttpGatewayRouteRewriteProperty | cdk.IResolvable; /** * An object that represents the target that traffic is routed to when a request matches the gateway route. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteaction.html#cfn-appmesh-gatewayroute-httpgatewayrouteaction-target */ readonly target: CfnGatewayRoute.GatewayRouteTargetProperty | cdk.IResolvable; } /** * An object that represents a gateway route target. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutetarget.html */ interface GatewayRouteTargetProperty { /** * The port number of the gateway route target. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutetarget.html#cfn-appmesh-gatewayroute-gatewayroutetarget-port */ readonly port?: number; /** * An object that represents a virtual service gateway route target. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutetarget.html#cfn-appmesh-gatewayroute-gatewayroutetarget-virtualservice */ readonly virtualService: CfnGatewayRoute.GatewayRouteVirtualServiceProperty | cdk.IResolvable; } /** * An object that represents the virtual service that traffic is routed to. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutevirtualservice.html */ interface GatewayRouteVirtualServiceProperty { /** * The name of the virtual service that traffic is routed to. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutevirtualservice.html#cfn-appmesh-gatewayroute-gatewayroutevirtualservice-virtualservicename */ readonly virtualServiceName: string; } /** * An object representing the gateway route to rewrite. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouterewrite.html */ interface HttpGatewayRouteRewriteProperty { /** * The host name to rewrite. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouterewrite.html#cfn-appmesh-gatewayroute-httpgatewayrouterewrite-hostname */ readonly hostname?: CfnGatewayRoute.GatewayRouteHostnameRewriteProperty | cdk.IResolvable; /** * The path to rewrite. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouterewrite.html#cfn-appmesh-gatewayroute-httpgatewayrouterewrite-path */ readonly path?: CfnGatewayRoute.HttpGatewayRoutePathRewriteProperty | cdk.IResolvable; /** * The specified beginning characters to rewrite. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouterewrite.html#cfn-appmesh-gatewayroute-httpgatewayrouterewrite-prefix */ readonly prefix?: CfnGatewayRoute.HttpGatewayRoutePrefixRewriteProperty | cdk.IResolvable; } /** * An object that represents the path to rewrite. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutepathrewrite.html */ interface HttpGatewayRoutePathRewriteProperty { /** * The exact path to rewrite. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutepathrewrite.html#cfn-appmesh-gatewayroute-httpgatewayroutepathrewrite-exact */ readonly exact?: string; } /** * An object representing the gateway route host name to rewrite. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutehostnamerewrite.html */ interface GatewayRouteHostnameRewriteProperty { /** * The default target host name to write to. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutehostnamerewrite.html#cfn-appmesh-gatewayroute-gatewayroutehostnamerewrite-defaulttargethostname */ readonly defaultTargetHostname?: string; } /** * An object representing the beginning characters of the route to rewrite. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteprefixrewrite.html */ interface HttpGatewayRoutePrefixRewriteProperty { /** * The default prefix used to replace the incoming route prefix when rewritten. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteprefixrewrite.html#cfn-appmesh-gatewayroute-httpgatewayrouteprefixrewrite-defaultprefix */ readonly defaultPrefix?: string; /** * The value used to replace the incoming route prefix when rewritten. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteprefixrewrite.html#cfn-appmesh-gatewayroute-httpgatewayrouteprefixrewrite-value */ readonly value?: string; } /** * An object that represents the criteria for determining a request match. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html */ interface HttpGatewayRouteMatchProperty { /** * The client request headers to match on. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-headers */ readonly headers?: Array<CfnGatewayRoute.HttpGatewayRouteHeaderProperty | cdk.IResolvable> | cdk.IResolvable; /** * The host name to match on. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-hostname */ readonly hostname?: CfnGatewayRoute.GatewayRouteHostnameMatchProperty | cdk.IResolvable; /** * The method to match on. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-method */ readonly method?: string; /** * The path to match on. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-path */ readonly path?: CfnGatewayRoute.HttpPathMatchProperty | cdk.IResolvable; /** * The port number to match on. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-port */ readonly port?: number; /** * Specifies the path to match requests with. * * This parameter must always start with `/` , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is `my-service.local` and you want the route to match requests to `my-service.local/metrics` , your prefix should be `/metrics` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-prefix */ readonly prefix?: string; /** * The query parameter to match on. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-queryparameters */ readonly queryParameters?: Array<cdk.IResolvable | CfnGatewayRoute.QueryParameterProperty> | cdk.IResolvable; } /** * An object representing the path to match in the request. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httppathmatch.html */ interface HttpPathMatchProperty { /** * The exact path to match on. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httppathmatch.html#cfn-appmesh-gatewayroute-httppathmatch-exact */ readonly exact?: string; /** * The regex used to match the path. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httppathmatch.html#cfn-appmesh-gatewayroute-httppathmatch-regex */ readonly regex?: string; } /** * An object that represents the HTTP header in the gateway route. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheader.html */ interface HttpGatewayRouteHeaderProperty { /** * Specify `True` to match anything except the match criteria. * * The default value is `False` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheader.html#cfn-appmesh-gatewayroute-httpgatewayrouteheader-invert */ readonly invert?: boolean | cdk.IResolvable; /** * An object that represents the method and value to match with the header value sent in a request. * * Specify one match method. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheader.html#cfn-appmesh-gatewayroute-httpgatewayrouteheader-match */ readonly match?: CfnGatewayRoute.HttpGatewayRouteHeaderMatchProperty | cdk.IResolvable; /** * A name for the HTTP header in the gateway route that will be matched on. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheader.html#cfn-appmesh-gatewayroute-httpgatewayrouteheader-name */ readonly name: string; } /** * An object that represents the method and value to match with the header value sent in a request. * * Specify one match method. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.html */ interface HttpGatewayRouteHeaderMatchProperty { /** * The value sent by the client must match the specified value exactly. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.html#cfn-appmesh-gatewayroute-httpgatewayrouteheadermatch-exact */ readonly exact?: string; /** * The value sent by the client must begin with the specified characters. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.html#cfn-appmesh-gatewayroute-httpgatewayrouteheadermatch-prefix */ readonly prefix?: string; /** * An object that represents the range of values to match on. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.html#cfn-appmesh-gatewayroute-httpgatewayrouteheadermatch-range */ readonly range?: CfnGatewayRoute.GatewayRouteRangeMatchProperty | cdk.IResolvable; /** * The value sent by the client must include the specified characters. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.html#cfn-appmesh-gatewayroute-httpgatewayrouteheadermatch-regex */ readonly regex?: string; /** * The value sent by the client must end with the specified characters. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.html#cfn-appmesh-gatewayroute-httpgatewayrouteheadermatch-suffix */ readonly suffix?: string; } /** * An object that represents the range of values to match on. * * The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayrouterangematch.html */ interface GatewayRouteRangeMatchProperty { /** * The end of the range. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayrouterangematch.html#cfn-appmesh-gatewayroute-gatewayrouterangematch-end */ readonly end: number; /** * The start of the range. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayrouterangematch.html#cfn-appmesh-gatewayroute-gatewayrouterangematch-start */ readonly start: number; } /** * An object representing the gateway route host name to match. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutehostnamematch.html */ interface GatewayRouteHostnameMatchProperty { /** * The exact host name to match on. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutehostnamematch.html#cfn-appmesh-gatewayroute-gatewayroutehostnamematch-exact */ readonly exact?: string; /** * The specified ending characters of the host name to match on. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutehostnamematch.html#cfn-appmesh-gatewayroute-gatewayroutehostnamematch-suffix */ readonly suffix?: string; } /** * An object that represents the query parameter in the request. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-queryparameter.html */ interface QueryParameterProperty { /** * The query parameter to match on. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-queryparameter.html#cfn-appmesh-gatewayroute-queryparameter-match */ readonly match?: CfnGatewayRoute.HttpQueryParameterMatchProperty | cdk.IResolvable; /** * A name for the query parameter that will be matched on. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-queryparameter.html#cfn-appmesh-gatewayroute-queryparameter-name */ readonly name: string; } /** * An object representing the query parameter to match. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpqueryparametermatch.html */ interface HttpQueryParameterMatchProperty { /** * The exact query parameter to match on. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpqueryparametermatch.html#cfn-appmesh-gatewayroute-httpqueryparametermatch-exact */ readonly exact?: string; } /** * An object that represents a gRPC gateway route. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroute.html */ interface GrpcGatewayRouteProperty { /** * An object that represents the action to take if a match is determined. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroute.html#cfn-appmesh-gatewayroute-grpcgatewayroute-action */ readonly action: CfnGatewayRoute.GrpcGatewayRouteActionProperty | cdk.IResolvable; /** * An object that represents the criteria for determining a request match. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroute.html#cfn-appmesh-gatewayroute-grpcgatewayroute-match */ readonly match: CfnGatewayRoute.GrpcGatewayRouteMatchProperty | cdk.IResolvable; } /** * An object that represents the action to take if a match is determined. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayrouteaction.html */ interface GrpcGatewayRouteActionProperty { /** * The gateway route action to rewrite. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayrouteaction.html#cfn-appmesh-gatewayroute-grpcgatewayrouteaction-rewrite */ readonly rewrite?: CfnGatewayRoute.GrpcGatewayRouteRewriteProperty | cdk.IResolvable; /** * An object that represents the target that traffic is routed to when a request matches the gateway route. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayrouteaction.html#cfn-appmesh-gatewayroute-grpcgatewayrouteaction-target */ readonly target: CfnGatewayRoute.GatewayRouteTargetProperty | cdk.IResolvable; } /** * An object that represents the gateway route to rewrite. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayrouterewrite.html */ interface GrpcGatewayRouteRewriteProperty { /** * The host name of the gateway route to rewrite. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayrouterewrite.html#cfn-appmesh-gatewayroute-grpcgatewayrouterewrite-hostname */ readonly hostname?: CfnGatewayRoute.GatewayRouteHostnameRewriteProperty | cdk.IResolvable; } /** * An object that represents the criteria for determining a request match. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutematch.html */ interface GrpcGatewayRouteMatchProperty { /** * The gateway route host name to be matched on. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutematch.html#cfn-appmesh-gatewayroute-grpcgatewayroutematch-hostname */ readonly hostname?: CfnGatewayRoute.GatewayRouteHostnameMatchProperty | cdk.IResolvable; /** * The gateway route metadata to be matched on. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutematch.html#cfn-appmesh-gatewayroute-grpcgatewayroutematch-metadata */ readonly metadata?: Array<CfnGatewayRoute.GrpcGatewayRouteMetadataProperty | cdk.IResolvable> | cdk.IResolvable; /** * The gateway route port to be matched on. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutematch.html#cfn-appmesh-gatewayroute-grpcgatewayroutematch-port */ readonly port?: number; /** * The fully qualified domain name for the service to match from the request. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutematch.html#cfn-appmesh-gatewayroute-grpcgatewayroutematch-servicename */ readonly serviceName?: string; } /** * An object representing the metadata of the gateway route. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutemetadata.html */ interface GrpcGatewayRouteMetadataProperty { /** * Specify `True` to match anything except the match criteria. * * The default value is `False` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutemetadata.html#cfn-appmesh-gatewayroute-grpcgatewayroutemetadata-invert */ readonly invert?: boolean | cdk.IResolvable; /** * The criteria for determining a metadata match. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutemetadata.html#cfn-appmesh-gatewayroute-grpcgatewayroutemetadata-match */ readonly match?: CfnGatewayRoute.GatewayRouteMetadataMatchProperty | cdk.IResolvable; /** * A name for the gateway route metadata. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutemetadata.html#cfn-appmesh-gatewayroute-grpcgatewayroutemetadata-name */ readonly name: string; } /** * An object representing the method header to be matched. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.html */ interface GatewayRouteMetadataMatchProperty { /** * The exact method header to be matched on. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.html#cfn-appmesh-gatewayroute-gatewayroutemetadatamatch-exact */ readonly exact?: string; /** * The specified beginning characters of the method header to be matched on. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.html#cfn-appmesh-gatewayroute-gatewayroutemetadatamatch-prefix */ readonly prefix?: string; /** * An object that represents the range of values to match on. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.html#cfn-appmesh-gatewayroute-gatewayroutemetadatamatch-range */ readonly range?: CfnGatewayRoute.GatewayRouteRangeMatchProperty | cdk.IResolvable; /** * The regex used to match the method header. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.html#cfn-appmesh-gatewayroute-gatewayroutemetadatamatch-regex */ readonly regex?: string; /** * The specified ending characters of the method header to match on. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.html#cfn-appmesh-gatewayroute-gatewayroutemetadatamatch-suffix */ readonly suffix?: string; } } /** * Properties for defining a `CfnGatewayRoute` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html */ export interface CfnGatewayRouteProps { /** * The name of the gateway route. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-gatewayroutename */ readonly gatewayRouteName?: string; /** * The name of the service mesh that the resource resides in. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-meshname */ readonly meshName: string; /** * The AWS IAM account ID of the service mesh owner. * * 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](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-meshowner */ readonly meshOwner?: string; /** * The specifications of the gateway route. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-spec */ readonly spec: CfnGatewayRoute.GatewayRouteSpecProperty | cdk.IResolvable; /** * Optional metadata that you can apply to the gateway route to assist with categorization and organization. * * 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-tags */ readonly tags?: Array<cdk.CfnTag>; /** * The virtual gateway that the gateway route is associated with. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-virtualgatewayname */ readonly virtualGatewayName: string; } /** * Creates a service mesh. * * A service mesh is a logical boundary for network traffic between services that are represented by resources within the mesh. After you create your service mesh, you can create virtual services, virtual nodes, virtual routers, and routes to distribute traffic between the applications in your mesh. * * For more information about service meshes, see [Service meshes](https://docs.aws.amazon.com/app-mesh/latest/userguide/meshes.html) . * * @cloudformationResource AWS::AppMesh::Mesh * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-mesh.html */ export declare class CfnMesh extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnMesh from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnMesh; /** * The full Amazon Resource Name (ARN) for the mesh. * * @cloudformationAttribute Arn */ readonly attrArn: string; /** * @cloudformationAttribute Id */ readonly attrId: string; /** * The name of the service mesh. * * @cloudformationAttribute MeshName */ readonly attrMeshName: string; /** * The IAM account ID of the service mesh owner. 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](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) . * * @cloudformationAttribute MeshOwner */ readonly attrMeshOwner: string; /** * The IAM account ID of the resource owner. 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](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) . * * @cloudformationAttribute ResourceOwner */ readonly attrResourceOwner: string; /** * The unique identifier for the mesh. * * @cloudformationAttribute Uid */ readonly attrUid: string; /** * The name to use for the service mesh. */ meshName?: string; /** * The service mesh specification to apply. */ spec?: cdk.IResolvable | CfnMesh.MeshSpecProperty; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * Optional metadata that you can apply to the service mesh to assist with categorization and organization. */ tagsRaw?: Array<cdk.CfnTag>; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props?: CfnMeshProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnMesh { /** * An object that represents the specification of a service mesh. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-meshspec.html */ interface MeshSpecProperty { /** * The egress filter rules for the service mesh. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-meshspec.html#cfn-appmesh-mesh-meshspec-egressfilter */ readonly egressFilter?: CfnMesh.EgressFilterProperty | cdk.IResolvable; /** * An object that represents the service discovery information for a service mesh. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-meshspec.html#cfn-appmesh-mesh-meshspec-servicediscovery */ readonly serviceDiscovery?: cdk.IResolvable | CfnMesh.MeshServiceDiscoveryProperty; } /** * An object that represents the egress filter rules for a service mesh. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-egressfilter.html */ interface EgressFilterProperty { /** * The egress filter type. * * By default, the type is `DROP_ALL` , which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to `*.amazonaws.com` for AWS API calls). You can set the egress filter type to `ALLOW_ALL` to allow egress to any endpoint inside or outside of the service mesh. * * > If you specify any backends on a virtual node when using `ALLOW_ALL` , you must specifiy all egress for that virtual node as backends. Otherwise, `ALLOW_ALL` will no longer work for that virtual node. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-egressfilter.html#cfn-appmesh-mesh-egressfilter-type */ readonly type: string; } /** * An object that represents the service discovery information for a service mesh. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-meshservicediscovery.html */ interface MeshServiceDiscoveryProperty { /** * The IP version to use to control traffic within the mesh. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-meshservicediscovery.html#cfn-appmesh-mesh-meshservicediscovery-ippreference */ readonly ipPreference?: string; } } /** * Properties for defining a `CfnMesh` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-mesh.html */ export interface CfnMeshProps { /** * The name to use for the service mesh. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-mesh.html#cfn-appmesh-mesh-meshname */ readonly meshName?: string; /** * The service mesh specification to apply. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-mesh.html#cfn-appmesh-mesh-spec */ readonly spec?: cdk.IResolvable | CfnMesh.MeshSpecProperty; /** * Optional metadata that you can apply to the service mesh to assist with categorization and organization. * * 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-mesh.html#cfn-appmesh-mesh-tags */ readonly tags?: Array<cdk.CfnTag>; } /** * Creates a route that is associated with a virtual router. * * You can route several different protocols and define a retry policy for a route. Traffic can be routed to one or more virtual nodes. * * For more information about routes, see [Routes](https://docs.aws.amazon.com/app-mesh/latest/userguide/routes.html) . * * @cloudformationResource AWS::AppMesh::Route * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-route.html */ export declare class CfnRoute extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnRoute from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnRoute; /** * The full Amazon Resource Name (ARN) for the route. * * @cloudformationAttribute Arn */ readonly attrArn: string; /** * @cloudformationAttribute Id */ readonly attrId: string; /** * The name of the service mesh that the route resides in. * * @cloudformationAttribute MeshName */ readonly attrMeshName: string; /** * The AWS IAM account ID of the service mesh owner. 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](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) . * * @cloudformationAttribute MeshOwner */ readonly attrMeshOwner: string; /** * The AWS IAM account ID of the resource owner. 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](https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html) . * * @cloudformationAttribute ResourceOwner */ readonly attrResourceOwner: string; /** * The name of the route. * * @cloudformationAttribute RouteName */ readonly attrRouteName: string; /** * The unique identifier for the route. * * @cloudformationAttribute Uid */ readonly attrUid: string; /** * The name of the virtual router that the route is associated with. * * @cloudformationAttribute VirtualRouterName */ readonly attrVirtualRouterName: string; /** * The name of the service mesh to create the route in. */ meshName: string; /** * The AWS IAM account ID of the service mesh owner. */ meshOwner?: string; /** * The name to use for the route. */ routeName?: string; /** * The route specification to apply. */ spec: cdk.IResolvable | CfnRoute.RouteSpecProperty; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * Optional metadata that you can apply to the route to assist with categorization and organization. */ tagsRaw?: Array<cdk.CfnTag>; /** * The name of the virtual router in which to create the route. */ virtualRouterName: string; /** * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnRouteProps); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnRoute { /** * An object that represents a route specification. * * Specify one route type. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html */ interface RouteSpecProperty { /** * An object that represents the specification of a gRPC route. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html#cfn-appmesh-route-routespec-grpcroute */ readonly grpcRoute?: CfnRoute.GrpcRouteProperty | cdk.IResolvable; /** * An object that represents the specification of an HTTP/2 route. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html#cfn-appmesh-route-routespec-http2route */ readonly http2Route?: CfnRoute.HttpRouteProperty | cdk.IResolvable; /** * An object that represents the specification of an HTTP route. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-routespec.html#cfn-appmesh-route-routespec-httproute */ readonly httpRoute?: CfnRoute.HttpRouteProperty | cdk.IResolvable; /** * The priority for the route.