class CfnGatewayRoute (construct)

Language	Type name
.NET	Amazon.CDK.AWS.AppMesh.CfnGatewayRoute
Java	software.amazon.awscdk.services.appmesh.CfnGatewayRoute
Python	aws_cdk.aws_appmesh.CfnGatewayRoute
TypeScript	@aws-cdk/aws-appmesh » CfnGatewayRoute

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::AppMesh::GatewayRoute.

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 .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as appmesh from '@aws-cdk/aws-appmesh';
const cfnGatewayRoute = new appmesh.CfnGatewayRoute(this, 'MyCfnGatewayRoute', {
  meshName: 'meshName',
  spec: {
    grpcRoute: {
      action: {
        target: {
          virtualService: {
            virtualServiceName: 'virtualServiceName',
          },

          // the properties below are optional
          port: 123,
        },

        // the properties below are optional
        rewrite: {
          hostname: {
            defaultTargetHostname: 'defaultTargetHostname',
          },
        },
      },
      match: {
        hostname: {
          exact: 'exact',
          suffix: 'suffix',
        },
        metadata: [{
          name: 'name',

          // the properties below are optional
          invert: false,
          match: {
            exact: 'exact',
            prefix: 'prefix',
            range: {
              end: 123,
              start: 123,
            },
            regex: 'regex',
            suffix: 'suffix',
          },
        }],
        port: 123,
        serviceName: 'serviceName',
      },
    },
    http2Route: {
      action: {
        target: {
          virtualService: {
            virtualServiceName: 'virtualServiceName',
          },

          // the properties below are optional
          port: 123,
        },

        // the properties below are optional
        rewrite: {
          hostname: {
            defaultTargetHostname: 'defaultTargetHostname',
          },
          path: {
            exact: 'exact',
          },
          prefix: {
            defaultPrefix: 'defaultPrefix',
            value: 'value',
          },
        },
      },
      match: {
        headers: [{
          name: 'name',

          // the properties below are optional
          invert: false,
          match: {
            exact: 'exact',
            prefix: 'prefix',
            range: {
              end: 123,
              start: 123,
            },
            regex: 'regex',
            suffix: 'suffix',
          },
        }],
        hostname: {
          exact: 'exact',
          suffix: 'suffix',
        },
        method: 'method',
        path: {
          exact: 'exact',
          regex: 'regex',
        },
        port: 123,
        prefix: 'prefix',
        queryParameters: [{
          name: 'name',

          // the properties below are optional
          match: {
            exact: 'exact',
          },
        }],
      },
    },
    httpRoute: {
      action: {
        target: {
          virtualService: {
            virtualServiceName: 'virtualServiceName',
          },

          // the properties below are optional
          port: 123,
        },

        // the properties below are optional
        rewrite: {
          hostname: {
            defaultTargetHostname: 'defaultTargetHostname',
          },
          path: {
            exact: 'exact',
          },
          prefix: {
            defaultPrefix: 'defaultPrefix',
            value: 'value',
          },
        },
      },
      match: {
        headers: [{
          name: 'name',

          // the properties below are optional
          invert: false,
          match: {
            exact: 'exact',
            prefix: 'prefix',
            range: {
              end: 123,
              start: 123,
            },
            regex: 'regex',
            suffix: 'suffix',
          },
        }],
        hostname: {
          exact: 'exact',
          suffix: 'suffix',
        },
        method: 'method',
        path: {
          exact: 'exact',
          regex: 'regex',
        },
        port: 123,
        prefix: 'prefix',
        queryParameters: [{
          name: 'name',

          // the properties below are optional
          match: {
            exact: 'exact',
          },
        }],
      },
    },
    priority: 123,
  },
  virtualGatewayName: 'virtualGatewayName',

  // the properties below are optional
  gatewayRouteName: 'gatewayRouteName',
  meshOwner: 'meshOwner',
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnGatewayRoute(scope: Construct, id: string, props: CfnGatewayRouteProps)

Parameters

• scope Construct — - scope in which this resource is defined.
• id string — - scoped id of the resource.
• props CfnGatewayRouteProps — - resource properties.

Create a new AWS::AppMesh::GatewayRoute.

Construct Props

Name	Type	Description
meshName	string	The name of the service mesh that the resource resides in.
spec	GatewayRouteSpecProperty | IResolvable	The specifications of the gateway route.
virtualGatewayName	string	The virtual gateway that the gateway route is associated with.
gatewayRouteName?	string	The name of the gateway route.
meshOwner?	string	The AWS IAM account ID of the service mesh owner.
tags?	CfnTag[]	Optional metadata that you can apply to the gateway route to assist with categorization and organization.

---

meshName

Type: string

The name of the service mesh that the resource resides in.

---

spec

Type: GatewayRouteSpecProperty | IResolvable

The specifications of the gateway route.

---

virtualGatewayName

Type: string

The virtual gateway that the gateway route is associated with.

---

gatewayRouteName?

Type: string (optional)

The name of the gateway route.

---

meshOwner?

Type: string (optional)

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 .

---

tags?

Type: CfnTag[] (optional)

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.

Properties

Name	Type	Description
attrArn	string	The full Amazon Resource Name (ARN) for the gateway route.
attrGatewayRouteName	string	The name of the gateway route.
attrMeshName	string	The name of the service mesh that the gateway route resides in.
attrMeshOwner	string	The AWS IAM account ID of the service mesh owner.
attrResourceOwner	string	The IAM account ID of the resource owner.
attrUid	string	The unique identifier for the gateway route.
attrVirtualGatewayName	string	The name of the virtual gateway that the gateway route is associated with.
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
creationStack	string[]
logicalId	string	The logical ID for this CloudFormation stack element.
meshName	string	The name of the service mesh that the resource resides in.
node	ConstructNode	The construct tree node associated with this construct.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
spec	GatewayRouteSpecProperty | IResolvable	The specifications of the gateway route.
stack	Stack	The stack in which this element is defined.
tags	TagManager	Optional metadata that you can apply to the gateway route to assist with categorization and organization.
virtualGatewayName	string	The virtual gateway that the gateway route is associated with.
gatewayRouteName?	string	The name of the gateway route.
meshOwner?	string	The AWS IAM account ID of the service mesh owner.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrArn

Type: string

The full Amazon Resource Name (ARN) for the gateway route.

---

attrGatewayRouteName

Type: string

The name of the gateway route.

---

attrMeshName

Type: string

The name of the service mesh that the gateway route resides in.

---

attrMeshOwner

Type: 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 .

---

attrResourceOwner

Type: 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 .

---

attrUid

Type: string

The unique identifier for the gateway route.

---

attrVirtualGatewayName

Type: string

The name of the virtual gateway that the gateway route is associated with.

---

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

creationStack

Type: string[]

---

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

meshName

Type: string

The name of the service mesh that the resource resides in.

---

node

Type: ConstructNode

The construct tree node associated with this construct.

---

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

spec

Type: GatewayRouteSpecProperty | IResolvable

The specifications of the gateway route.

---

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

---

tags

Type: TagManager

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.

---

virtualGatewayName

Type: string

The virtual gateway that the gateway route is associated with.

---

gatewayRouteName?

Type: string (optional)

The name of the gateway route.

---

meshOwner?

Type: string (optional)

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 .

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

---

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

• path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

---

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

---

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

• path string — - The path of the property, you can use dot notation to override values in complex types.
• value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

---

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

• propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

---

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

• propertyPath string — The path of the property.
• value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

---

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

• policy RemovalPolicy
• options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

• attributeName string — The name of the attribute.

Returns

• Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

---

getMetadata(key)

public getMetadata(key: string): any

Parameters

• key string

Returns

• any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

• inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

---

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

• newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

• props { [string]: any }

Returns

• { [string]: any }