aws-cdk-lib.aws_appmesh.CfnVirtualNode

class CfnVirtualNode (construct)

LanguageType name
.NETAmazon.CDK.AWS.AppMesh.CfnVirtualNode
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappmesh#CfnVirtualNode
Javasoftware.amazon.awscdk.services.appmesh.CfnVirtualNode
Pythonaws_cdk.aws_appmesh.CfnVirtualNode
TypeScript aws-cdk-lib » aws_appmesh » CfnVirtualNode

Implements IConstruct, IDependable, IInspectable

A CloudFormation AWS::AppMesh::VirtualNode.

Creates a virtual node within a service mesh.

A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you can specify the service discovery information for your task group, and whether the proxy running in a task group will communicate with other proxies using Transport Layer Security (TLS).

You define a listener for any inbound traffic that your virtual node expects. Any virtual service that your virtual node expects to communicate to is specified as a backend .

The response metadata for your new virtual node contains the arn that is associated with the virtual node. Set this value to the full ARN; for example, arn:aws:appmesh:us-west-2:123456789012:myMesh/default/virtualNode/myApp ) as the APPMESH_RESOURCE_ARN environment variable for your task group's Envoy proxy container in your task definition or pod spec. This is then mapped to the node.id and node.cluster Envoy parameters.

By default, App Mesh uses the name of the resource you specified in APPMESH_RESOURCE_ARN when Envoy is referring to itself in metrics and traces. You can override this behavior by setting the APPMESH_RESOURCE_CLUSTER environment variable with your own name.

For more information about virtual nodes, see Virtual nodes . You must be using 1.15.0 or later of the Envoy image when setting these variables. For more information about App Mesh Envoy variables, see Envoy image in the AWS App Mesh User Guide.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appmesh as appmesh } from 'aws-cdk-lib';
const cfnVirtualNode = new appmesh.CfnVirtualNode(this, 'MyCfnVirtualNode', {
  meshName: 'meshName',
  spec: {
    backendDefaults: {
      clientPolicy: {
        tls: {
          validation: {
            trust: {
              acm: {
                certificateAuthorityArns: ['certificateAuthorityArns'],
              },
              file: {
                certificateChain: 'certificateChain',
              },
              sds: {
                secretName: 'secretName',
              },
            },

            // the properties below are optional
            subjectAlternativeNames: {
              match: {
                exact: ['exact'],
              },
            },
          },

          // the properties below are optional
          certificate: {
            file: {
              certificateChain: 'certificateChain',
              privateKey: 'privateKey',
            },
            sds: {
              secretName: 'secretName',
            },
          },
          enforce: false,
          ports: [123],
        },
      },
    },
    backends: [{
      virtualService: {
        virtualServiceName: 'virtualServiceName',

        // the properties below are optional
        clientPolicy: {
          tls: {
            validation: {
              trust: {
                acm: {
                  certificateAuthorityArns: ['certificateAuthorityArns'],
                },
                file: {
                  certificateChain: 'certificateChain',
                },
                sds: {
                  secretName: 'secretName',
                },
              },

              // the properties below are optional
              subjectAlternativeNames: {
                match: {
                  exact: ['exact'],
                },
              },
            },

            // the properties below are optional
            certificate: {
              file: {
                certificateChain: 'certificateChain',
                privateKey: 'privateKey',
              },
              sds: {
                secretName: 'secretName',
              },
            },
            enforce: false,
            ports: [123],
          },
        },
      },
    }],
    listeners: [{
      portMapping: {
        port: 123,
        protocol: 'protocol',
      },

      // the properties below are optional
      connectionPool: {
        grpc: {
          maxRequests: 123,
        },
        http: {
          maxConnections: 123,

          // the properties below are optional
          maxPendingRequests: 123,
        },
        http2: {
          maxRequests: 123,
        },
        tcp: {
          maxConnections: 123,
        },
      },
      healthCheck: {
        healthyThreshold: 123,
        intervalMillis: 123,
        protocol: 'protocol',
        timeoutMillis: 123,
        unhealthyThreshold: 123,

        // the properties below are optional
        path: 'path',
        port: 123,
      },
      outlierDetection: {
        baseEjectionDuration: {
          unit: 'unit',
          value: 123,
        },
        interval: {
          unit: 'unit',
          value: 123,
        },
        maxEjectionPercent: 123,
        maxServerErrors: 123,
      },
      timeout: {
        grpc: {
          idle: {
            unit: 'unit',
            value: 123,
          },
          perRequest: {
            unit: 'unit',
            value: 123,
          },
        },
        http: {
          idle: {
            unit: 'unit',
            value: 123,
          },
          perRequest: {
            unit: 'unit',
            value: 123,
          },
        },
        http2: {
          idle: {
            unit: 'unit',
            value: 123,
          },
          perRequest: {
            unit: 'unit',
            value: 123,
          },
        },
        tcp: {
          idle: {
            unit: 'unit',
            value: 123,
          },
        },
      },
      tls: {
        certificate: {
          acm: {
            certificateArn: 'certificateArn',
          },
          file: {
            certificateChain: 'certificateChain',
            privateKey: 'privateKey',
          },
          sds: {
            secretName: 'secretName',
          },
        },
        mode: 'mode',

        // the properties below are optional
        validation: {
          trust: {
            file: {
              certificateChain: 'certificateChain',
            },
            sds: {
              secretName: 'secretName',
            },
          },

          // the properties below are optional
          subjectAlternativeNames: {
            match: {
              exact: ['exact'],
            },
          },
        },
      },
    }],
    logging: {
      accessLog: {
        file: {
          path: 'path',

          // the properties below are optional
          format: {
            json: [{
              key: 'key',
              value: 'value',
            }],
            text: 'text',
          },
        },
      },
    },
    serviceDiscovery: {
      awsCloudMap: {
        namespaceName: 'namespaceName',
        serviceName: 'serviceName',

        // the properties below are optional
        attributes: [{
          key: 'key',
          value: 'value',
        }],
        ipPreference: 'ipPreference',
      },
      dns: {
        hostname: 'hostname',

        // the properties below are optional
        ipPreference: 'ipPreference',
        responseType: 'responseType',
      },
    },
  },

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

Initializer

new CfnVirtualNode(scope: Construct, id: string, props: CfnVirtualNodeProps)

Parameters

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

Create a new AWS::AppMesh::VirtualNode.

Construct Props

NameTypeDescription
meshNamestringThe name of the service mesh to create the virtual node in.
specIResolvable | VirtualNodeSpecPropertyThe virtual node specification to apply.
meshOwner?stringThe AWS IAM account ID of the service mesh owner.
tags?CfnTag[]Optional metadata that you can apply to the virtual node to assist with categorization and organization.
virtualNodeName?stringThe name to use for the virtual node.

meshName

Type: string

The name of the service mesh to create the virtual node in.


spec

Type: IResolvable | VirtualNodeSpecProperty

The virtual node specification to apply.


meshOwner?

Type: string (optional)

The AWS IAM account ID of the service mesh owner.

If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes .


tags?

Type: CfnTag[] (optional)

Optional metadata that you can apply to the virtual node 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.


virtualNodeName?

Type: string (optional)

The name to use for the virtual node.

Properties

NameTypeDescription
attrArnstringThe full Amazon Resource Name (ARN) for the virtual node.
attrMeshNamestringThe name of the service mesh that the virtual node resides in.
attrMeshOwnerstringThe AWS IAM account ID of the service mesh owner.
attrResourceOwnerstringThe AWS IAM account ID of the resource owner.
attrUidstringThe unique identifier for the virtual node.
attrVirtualNodeNamestringThe name of the virtual node.
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
logicalIdstringThe logical ID for this CloudFormation stack element.
meshNamestringThe name of the service mesh to create the virtual node in.
nodeNodeThe tree node.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
specIResolvable | VirtualNodeSpecPropertyThe virtual node specification to apply.
stackStackThe stack in which this element is defined.
tagsTagManagerOptional metadata that you can apply to the virtual node to assist with categorization and organization.
meshOwner?stringThe AWS IAM account ID of the service mesh owner.
virtualNodeName?stringThe name to use for the virtual node.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

attrArn

Type: string

The full Amazon Resource Name (ARN) for the virtual node.


attrMeshName

Type: string

The name of the service mesh that the virtual node 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 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 .


attrUid

Type: string

The unique identifier for the virtual node.


attrVirtualNodeName

Type: string

The name of the virtual node.


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 to create the virtual node in.


node

Type: Node

The tree node.


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: IResolvable | VirtualNodeSpecProperty

The virtual node specification to apply.


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 virtual node 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.


meshOwner?

Type: string (optional)

The AWS IAM account ID of the service mesh owner.

If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes .


virtualNodeName?

Type: string (optional)

The name to use for the virtual node.


static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependency(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
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, typeHint?)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.
obtainDependencies()Retrieves an array of resources this resource depends on.
obtainResourceDependencies()Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)Replaces one dependency with another.
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).


addDependency(target)

public addDependency(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.


addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

  • target CfnResource

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


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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options


getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

  • attributeName string — The name of the attribute.
  • typeHint ResolutionTypeHint

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.


obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

  • Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.


obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

  • CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.


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.


removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.


replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

  • target CfnResource — The dependency to replace.
  • newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.


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 }