class CfnRoutePropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.AppMesh.Mixins.CfnRoutePropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsappmesh/mixins#CfnRoutePropsMixin
Java	software.amazon.awscdk.mixins.preview.services.appmesh.mixins.CfnRoutePropsMixin
Python	aws_cdk.mixins_preview.aws_appmesh.mixins.CfnRoutePropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_appmesh » mixins » CfnRoutePropsMixin

Implements IMixin

Extends Mixin

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-route.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as appmesh_mixins } from '@aws-cdk/mixins-preview/aws-appmesh';
const cfnRoutePropsMixin = new appmesh_mixins.CfnRoutePropsMixin({
  meshName: 'meshName',
  meshOwner: 'meshOwner',
  routeName: 'routeName',
  spec: {
    grpcRoute: {
      action: {
        weightedTargets: [{
          port: 123,
          virtualNode: 'virtualNode',
          weight: 123,
        }],
      },
      match: {
        metadata: [{
          invert: false,
          match: {
            exact: 'exact',
            prefix: 'prefix',
            range: {
              end: 123,
              start: 123,
            },
            regex: 'regex',
            suffix: 'suffix',
          },
          name: 'name',
        }],
        methodName: 'methodName',
        port: 123,
        serviceName: 'serviceName',
      },
      retryPolicy: {
        grpcRetryEvents: ['grpcRetryEvents'],
        httpRetryEvents: ['httpRetryEvents'],
        maxRetries: 123,
        perRetryTimeout: {
          unit: 'unit',
          value: 123,
        },
        tcpRetryEvents: ['tcpRetryEvents'],
      },
      timeout: {
        idle: {
          unit: 'unit',
          value: 123,
        },
        perRequest: {
          unit: 'unit',
          value: 123,
        },
      },
    },
    http2Route: {
      action: {
        weightedTargets: [{
          port: 123,
          virtualNode: 'virtualNode',
          weight: 123,
        }],
      },
      match: {
        headers: [{
          invert: false,
          match: {
            exact: 'exact',
            prefix: 'prefix',
            range: {
              end: 123,
              start: 123,
            },
            regex: 'regex',
            suffix: 'suffix',
          },
          name: 'name',
        }],
        method: 'method',
        path: {
          exact: 'exact',
          regex: 'regex',
        },
        port: 123,
        prefix: 'prefix',
        queryParameters: [{
          match: {
            exact: 'exact',
          },
          name: 'name',
        }],
        scheme: 'scheme',
      },
      retryPolicy: {
        httpRetryEvents: ['httpRetryEvents'],
        maxRetries: 123,
        perRetryTimeout: {
          unit: 'unit',
          value: 123,
        },
        tcpRetryEvents: ['tcpRetryEvents'],
      },
      timeout: {
        idle: {
          unit: 'unit',
          value: 123,
        },
        perRequest: {
          unit: 'unit',
          value: 123,
        },
      },
    },
    httpRoute: {
      action: {
        weightedTargets: [{
          port: 123,
          virtualNode: 'virtualNode',
          weight: 123,
        }],
      },
      match: {
        headers: [{
          invert: false,
          match: {
            exact: 'exact',
            prefix: 'prefix',
            range: {
              end: 123,
              start: 123,
            },
            regex: 'regex',
            suffix: 'suffix',
          },
          name: 'name',
        }],
        method: 'method',
        path: {
          exact: 'exact',
          regex: 'regex',
        },
        port: 123,
        prefix: 'prefix',
        queryParameters: [{
          match: {
            exact: 'exact',
          },
          name: 'name',
        }],
        scheme: 'scheme',
      },
      retryPolicy: {
        httpRetryEvents: ['httpRetryEvents'],
        maxRetries: 123,
        perRetryTimeout: {
          unit: 'unit',
          value: 123,
        },
        tcpRetryEvents: ['tcpRetryEvents'],
      },
      timeout: {
        idle: {
          unit: 'unit',
          value: 123,
        },
        perRequest: {
          unit: 'unit',
          value: 123,
        },
      },
    },
    priority: 123,
    tcpRoute: {
      action: {
        weightedTargets: [{
          port: 123,
          virtualNode: 'virtualNode',
          weight: 123,
        }],
      },
      match: {
        port: 123,
      },
      timeout: {
        idle: {
          unit: 'unit',
          value: 123,
        },
      },
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  virtualRouterName: 'virtualRouterName',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnRoutePropsMixin(props: CfnRouteMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnRouteMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::AppMesh::Route.

Properties

Name	Type	Description
props	CfnRouteMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnRouteMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.