Show / Hide Table of Contents

Class CfnVirtualNodePropsMixin

Creates a virtual node within a service mesh.

Inheritance
object
Mixin
CfnVirtualNodePropsMixin
Implements
IMixin
Inherited Members
Mixin.IsMixin(object)
Namespace: Amazon.CDK.Mixins.Preview.AWS.AppMesh.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public class CfnVirtualNodePropsMixin : Mixin, IMixin
Syntax (vb)
Public Class CfnVirtualNodePropsMixin Inherits Mixin Implements IMixin
Remarks

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 <code>APPMESH_RESOURCE_ARN</code> when Envoy is referring to itself in metrics and traces. You can override this behavior by setting the <code>APPMESH_RESOURCE_CLUSTER</code> 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 aboutApp Mesh Envoy variables, see Envoy image in the AWS App Mesh User Guide.

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

CloudformationResource: AWS::AppMesh::VirtualNode

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.AppMesh.Mixins;

             var cfnVirtualNodePropsMixin = new CfnVirtualNodePropsMixin(new CfnVirtualNodeMixinProps {
                 MeshName = "meshName",
                 MeshOwner = "meshOwner",
                 Spec = new VirtualNodeSpecProperty {
                     BackendDefaults = new BackendDefaultsProperty {
                         ClientPolicy = new ClientPolicyProperty {
                             Tls = new ClientPolicyTlsProperty {
                                 Certificate = new ClientTlsCertificateProperty {
                                     File = new ListenerTlsFileCertificateProperty {
                                         CertificateChain = "certificateChain",
                                         PrivateKey = "privateKey"
                                     },
                                     Sds = new ListenerTlsSdsCertificateProperty {
                                         SecretName = "secretName"
                                     }
                                 },
                                 Enforce = false,
                                 Ports = new [] { 123 },
                                 Validation = new TlsValidationContextProperty {
                                     SubjectAlternativeNames = new SubjectAlternativeNamesProperty {
                                         Match = new SubjectAlternativeNameMatchersProperty {
                                             Exact = new [] { "exact" }
                                         }
                                     },
                                     Trust = new TlsValidationContextTrustProperty {
                                         Acm = new TlsValidationContextAcmTrustProperty {
                                             CertificateAuthorityArns = new [] { "certificateAuthorityArns" }
                                         },
                                         File = new TlsValidationContextFileTrustProperty {
                                             CertificateChain = "certificateChain"
                                         },
                                         Sds = new TlsValidationContextSdsTrustProperty {
                                             SecretName = "secretName"
                                         }
                                     }
                                 }
                             }
                         }
                     },
                     Backends = new [] { new BackendProperty {
                         VirtualService = new VirtualServiceBackendProperty {
                             ClientPolicy = new ClientPolicyProperty {
                                 Tls = new ClientPolicyTlsProperty {
                                     Certificate = new ClientTlsCertificateProperty {
                                         File = new ListenerTlsFileCertificateProperty {
                                             CertificateChain = "certificateChain",
                                             PrivateKey = "privateKey"
                                         },
                                         Sds = new ListenerTlsSdsCertificateProperty {
                                             SecretName = "secretName"
                                         }
                                     },
                                     Enforce = false,
                                     Ports = new [] { 123 },
                                     Validation = new TlsValidationContextProperty {
                                         SubjectAlternativeNames = new SubjectAlternativeNamesProperty {
                                             Match = new SubjectAlternativeNameMatchersProperty {
                                                 Exact = new [] { "exact" }
                                             }
                                         },
                                         Trust = new TlsValidationContextTrustProperty {
                                             Acm = new TlsValidationContextAcmTrustProperty {
                                                 CertificateAuthorityArns = new [] { "certificateAuthorityArns" }
                                             },
                                             File = new TlsValidationContextFileTrustProperty {
                                                 CertificateChain = "certificateChain"
                                             },
                                             Sds = new TlsValidationContextSdsTrustProperty {
                                                 SecretName = "secretName"
                                             }
                                         }
                                     }
                                 }
                             },
                             VirtualServiceName = "virtualServiceName"
                         }
                     } },
                     Listeners = new [] { new ListenerProperty {
                         ConnectionPool = new VirtualNodeConnectionPoolProperty {
                             Grpc = new VirtualNodeGrpcConnectionPoolProperty {
                                 MaxRequests = 123
                             },
                             Http = new VirtualNodeHttpConnectionPoolProperty {
                                 MaxConnections = 123,
                                 MaxPendingRequests = 123
                             },
                             Http2 = new VirtualNodeHttp2ConnectionPoolProperty {
                                 MaxRequests = 123
                             },
                             Tcp = new VirtualNodeTcpConnectionPoolProperty {
                                 MaxConnections = 123
                             }
                         },
                         HealthCheck = new HealthCheckProperty {
                             HealthyThreshold = 123,
                             IntervalMillis = 123,
                             Path = "path",
                             Port = 123,
                             Protocol = "protocol",
                             TimeoutMillis = 123,
                             UnhealthyThreshold = 123
                         },
                         OutlierDetection = new OutlierDetectionProperty {
                             BaseEjectionDuration = new DurationProperty {
                                 Unit = "unit",
                                 Value = 123
                             },
                             Interval = new DurationProperty {
                                 Unit = "unit",
                                 Value = 123
                             },
                             MaxEjectionPercent = 123,
                             MaxServerErrors = 123
                         },
                         PortMapping = new PortMappingProperty {
                             Port = 123,
                             Protocol = "protocol"
                         },
                         Timeout = new ListenerTimeoutProperty {
                             Grpc = new GrpcTimeoutProperty {
                                 Idle = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 },
                                 PerRequest = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 }
                             },
                             Http = new HttpTimeoutProperty {
                                 Idle = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 },
                                 PerRequest = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 }
                             },
                             Http2 = new HttpTimeoutProperty {
                                 Idle = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 },
                                 PerRequest = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 }
                             },
                             Tcp = new TcpTimeoutProperty {
                                 Idle = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 }
                             }
                         },
                         Tls = new ListenerTlsProperty {
                             Certificate = new ListenerTlsCertificateProperty {
                                 Acm = new ListenerTlsAcmCertificateProperty {
                                     CertificateArn = "certificateArn"
                                 },
                                 File = new ListenerTlsFileCertificateProperty {
                                     CertificateChain = "certificateChain",
                                     PrivateKey = "privateKey"
                                 },
                                 Sds = new ListenerTlsSdsCertificateProperty {
                                     SecretName = "secretName"
                                 }
                             },
                             Mode = "mode",
                             Validation = new ListenerTlsValidationContextProperty {
                                 SubjectAlternativeNames = new SubjectAlternativeNamesProperty {
                                     Match = new SubjectAlternativeNameMatchersProperty {
                                         Exact = new [] { "exact" }
                                     }
                                 },
                                 Trust = new ListenerTlsValidationContextTrustProperty {
                                     File = new TlsValidationContextFileTrustProperty {
                                         CertificateChain = "certificateChain"
                                     },
                                     Sds = new TlsValidationContextSdsTrustProperty {
                                         SecretName = "secretName"
                                     }
                                 }
                             }
                         }
                     } },
                     Logging = new LoggingProperty {
                         AccessLog = new AccessLogProperty {
                             File = new FileAccessLogProperty {
                                 Format = new LoggingFormatProperty {
                                     Json = new [] { new JsonFormatRefProperty {
                                         Key = "key",
                                         Value = "value"
                                     } },
                                     Text = "text"
                                 },
                                 Path = "path"
                             }
                         }
                     },
                     ServiceDiscovery = new ServiceDiscoveryProperty {
                         AwsCloudMap = new AwsCloudMapServiceDiscoveryProperty {
                             Attributes = new [] { new AwsCloudMapInstanceAttributeProperty {
                                 Key = "key",
                                 Value = "value"
                             } },
                             IpPreference = "ipPreference",
                             NamespaceName = "namespaceName",
                             ServiceName = "serviceName"
                         },
                         Dns = new DnsServiceDiscoveryProperty {
                             Hostname = "hostname",
                             IpPreference = "ipPreference",
                             ResponseType = "responseType"
                         }
                     }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VirtualNodeName = "virtualNodeName"
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Synopsis

Constructors

CfnVirtualNodePropsMixin(ICfnVirtualNodeMixinProps, ICfnPropertyMixinOptions?)

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

Properties

CFN_PROPERTY_KEYS

Creates a virtual node within a service mesh.

Props

Creates a virtual node within a service mesh.

Strategy

Creates a virtual node within a service mesh.

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

Supports(IConstruct)

Check if this mixin supports the given construct.

Constructors

CfnVirtualNodePropsMixin(ICfnVirtualNodeMixinProps, ICfnPropertyMixinOptions?)

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

public CfnVirtualNodePropsMixin(ICfnVirtualNodeMixinProps props, ICfnPropertyMixinOptions? options = null)
Parameters
props ICfnVirtualNodeMixinProps

L1 properties to apply.

options ICfnPropertyMixinOptions

Mixin options.

Remarks

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 <code>APPMESH_RESOURCE_ARN</code> when Envoy is referring to itself in metrics and traces. You can override this behavior by setting the <code>APPMESH_RESOURCE_CLUSTER</code> 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 aboutApp Mesh Envoy variables, see Envoy image in the AWS App Mesh User Guide.

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

CloudformationResource: AWS::AppMesh::VirtualNode

Mixin: true

ExampleMetadata: fixture=_generated

Properties

CFN_PROPERTY_KEYS

Creates a virtual node within a service mesh.

protected static string[] CFN_PROPERTY_KEYS { get; }
Property Value

string[]

Remarks

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 <code>APPMESH_RESOURCE_ARN</code> when Envoy is referring to itself in metrics and traces. You can override this behavior by setting the <code>APPMESH_RESOURCE_CLUSTER</code> 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 aboutApp Mesh Envoy variables, see Envoy image in the AWS App Mesh User Guide.

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

CloudformationResource: AWS::AppMesh::VirtualNode

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.AppMesh.Mixins;

             var cfnVirtualNodePropsMixin = new CfnVirtualNodePropsMixin(new CfnVirtualNodeMixinProps {
                 MeshName = "meshName",
                 MeshOwner = "meshOwner",
                 Spec = new VirtualNodeSpecProperty {
                     BackendDefaults = new BackendDefaultsProperty {
                         ClientPolicy = new ClientPolicyProperty {
                             Tls = new ClientPolicyTlsProperty {
                                 Certificate = new ClientTlsCertificateProperty {
                                     File = new ListenerTlsFileCertificateProperty {
                                         CertificateChain = "certificateChain",
                                         PrivateKey = "privateKey"
                                     },
                                     Sds = new ListenerTlsSdsCertificateProperty {
                                         SecretName = "secretName"
                                     }
                                 },
                                 Enforce = false,
                                 Ports = new [] { 123 },
                                 Validation = new TlsValidationContextProperty {
                                     SubjectAlternativeNames = new SubjectAlternativeNamesProperty {
                                         Match = new SubjectAlternativeNameMatchersProperty {
                                             Exact = new [] { "exact" }
                                         }
                                     },
                                     Trust = new TlsValidationContextTrustProperty {
                                         Acm = new TlsValidationContextAcmTrustProperty {
                                             CertificateAuthorityArns = new [] { "certificateAuthorityArns" }
                                         },
                                         File = new TlsValidationContextFileTrustProperty {
                                             CertificateChain = "certificateChain"
                                         },
                                         Sds = new TlsValidationContextSdsTrustProperty {
                                             SecretName = "secretName"
                                         }
                                     }
                                 }
                             }
                         }
                     },
                     Backends = new [] { new BackendProperty {
                         VirtualService = new VirtualServiceBackendProperty {
                             ClientPolicy = new ClientPolicyProperty {
                                 Tls = new ClientPolicyTlsProperty {
                                     Certificate = new ClientTlsCertificateProperty {
                                         File = new ListenerTlsFileCertificateProperty {
                                             CertificateChain = "certificateChain",
                                             PrivateKey = "privateKey"
                                         },
                                         Sds = new ListenerTlsSdsCertificateProperty {
                                             SecretName = "secretName"
                                         }
                                     },
                                     Enforce = false,
                                     Ports = new [] { 123 },
                                     Validation = new TlsValidationContextProperty {
                                         SubjectAlternativeNames = new SubjectAlternativeNamesProperty {
                                             Match = new SubjectAlternativeNameMatchersProperty {
                                                 Exact = new [] { "exact" }
                                             }
                                         },
                                         Trust = new TlsValidationContextTrustProperty {
                                             Acm = new TlsValidationContextAcmTrustProperty {
                                                 CertificateAuthorityArns = new [] { "certificateAuthorityArns" }
                                             },
                                             File = new TlsValidationContextFileTrustProperty {
                                                 CertificateChain = "certificateChain"
                                             },
                                             Sds = new TlsValidationContextSdsTrustProperty {
                                                 SecretName = "secretName"
                                             }
                                         }
                                     }
                                 }
                             },
                             VirtualServiceName = "virtualServiceName"
                         }
                     } },
                     Listeners = new [] { new ListenerProperty {
                         ConnectionPool = new VirtualNodeConnectionPoolProperty {
                             Grpc = new VirtualNodeGrpcConnectionPoolProperty {
                                 MaxRequests = 123
                             },
                             Http = new VirtualNodeHttpConnectionPoolProperty {
                                 MaxConnections = 123,
                                 MaxPendingRequests = 123
                             },
                             Http2 = new VirtualNodeHttp2ConnectionPoolProperty {
                                 MaxRequests = 123
                             },
                             Tcp = new VirtualNodeTcpConnectionPoolProperty {
                                 MaxConnections = 123
                             }
                         },
                         HealthCheck = new HealthCheckProperty {
                             HealthyThreshold = 123,
                             IntervalMillis = 123,
                             Path = "path",
                             Port = 123,
                             Protocol = "protocol",
                             TimeoutMillis = 123,
                             UnhealthyThreshold = 123
                         },
                         OutlierDetection = new OutlierDetectionProperty {
                             BaseEjectionDuration = new DurationProperty {
                                 Unit = "unit",
                                 Value = 123
                             },
                             Interval = new DurationProperty {
                                 Unit = "unit",
                                 Value = 123
                             },
                             MaxEjectionPercent = 123,
                             MaxServerErrors = 123
                         },
                         PortMapping = new PortMappingProperty {
                             Port = 123,
                             Protocol = "protocol"
                         },
                         Timeout = new ListenerTimeoutProperty {
                             Grpc = new GrpcTimeoutProperty {
                                 Idle = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 },
                                 PerRequest = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 }
                             },
                             Http = new HttpTimeoutProperty {
                                 Idle = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 },
                                 PerRequest = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 }
                             },
                             Http2 = new HttpTimeoutProperty {
                                 Idle = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 },
                                 PerRequest = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 }
                             },
                             Tcp = new TcpTimeoutProperty {
                                 Idle = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 }
                             }
                         },
                         Tls = new ListenerTlsProperty {
                             Certificate = new ListenerTlsCertificateProperty {
                                 Acm = new ListenerTlsAcmCertificateProperty {
                                     CertificateArn = "certificateArn"
                                 },
                                 File = new ListenerTlsFileCertificateProperty {
                                     CertificateChain = "certificateChain",
                                     PrivateKey = "privateKey"
                                 },
                                 Sds = new ListenerTlsSdsCertificateProperty {
                                     SecretName = "secretName"
                                 }
                             },
                             Mode = "mode",
                             Validation = new ListenerTlsValidationContextProperty {
                                 SubjectAlternativeNames = new SubjectAlternativeNamesProperty {
                                     Match = new SubjectAlternativeNameMatchersProperty {
                                         Exact = new [] { "exact" }
                                     }
                                 },
                                 Trust = new ListenerTlsValidationContextTrustProperty {
                                     File = new TlsValidationContextFileTrustProperty {
                                         CertificateChain = "certificateChain"
                                     },
                                     Sds = new TlsValidationContextSdsTrustProperty {
                                         SecretName = "secretName"
                                     }
                                 }
                             }
                         }
                     } },
                     Logging = new LoggingProperty {
                         AccessLog = new AccessLogProperty {
                             File = new FileAccessLogProperty {
                                 Format = new LoggingFormatProperty {
                                     Json = new [] { new JsonFormatRefProperty {
                                         Key = "key",
                                         Value = "value"
                                     } },
                                     Text = "text"
                                 },
                                 Path = "path"
                             }
                         }
                     },
                     ServiceDiscovery = new ServiceDiscoveryProperty {
                         AwsCloudMap = new AwsCloudMapServiceDiscoveryProperty {
                             Attributes = new [] { new AwsCloudMapInstanceAttributeProperty {
                                 Key = "key",
                                 Value = "value"
                             } },
                             IpPreference = "ipPreference",
                             NamespaceName = "namespaceName",
                             ServiceName = "serviceName"
                         },
                         Dns = new DnsServiceDiscoveryProperty {
                             Hostname = "hostname",
                             IpPreference = "ipPreference",
                             ResponseType = "responseType"
                         }
                     }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VirtualNodeName = "virtualNodeName"
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Props

Creates a virtual node within a service mesh.

protected virtual ICfnVirtualNodeMixinProps Props { get; }
Property Value

ICfnVirtualNodeMixinProps

Remarks

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 <code>APPMESH_RESOURCE_ARN</code> when Envoy is referring to itself in metrics and traces. You can override this behavior by setting the <code>APPMESH_RESOURCE_CLUSTER</code> 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 aboutApp Mesh Envoy variables, see Envoy image in the AWS App Mesh User Guide.

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

CloudformationResource: AWS::AppMesh::VirtualNode

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.AppMesh.Mixins;

             var cfnVirtualNodePropsMixin = new CfnVirtualNodePropsMixin(new CfnVirtualNodeMixinProps {
                 MeshName = "meshName",
                 MeshOwner = "meshOwner",
                 Spec = new VirtualNodeSpecProperty {
                     BackendDefaults = new BackendDefaultsProperty {
                         ClientPolicy = new ClientPolicyProperty {
                             Tls = new ClientPolicyTlsProperty {
                                 Certificate = new ClientTlsCertificateProperty {
                                     File = new ListenerTlsFileCertificateProperty {
                                         CertificateChain = "certificateChain",
                                         PrivateKey = "privateKey"
                                     },
                                     Sds = new ListenerTlsSdsCertificateProperty {
                                         SecretName = "secretName"
                                     }
                                 },
                                 Enforce = false,
                                 Ports = new [] { 123 },
                                 Validation = new TlsValidationContextProperty {
                                     SubjectAlternativeNames = new SubjectAlternativeNamesProperty {
                                         Match = new SubjectAlternativeNameMatchersProperty {
                                             Exact = new [] { "exact" }
                                         }
                                     },
                                     Trust = new TlsValidationContextTrustProperty {
                                         Acm = new TlsValidationContextAcmTrustProperty {
                                             CertificateAuthorityArns = new [] { "certificateAuthorityArns" }
                                         },
                                         File = new TlsValidationContextFileTrustProperty {
                                             CertificateChain = "certificateChain"
                                         },
                                         Sds = new TlsValidationContextSdsTrustProperty {
                                             SecretName = "secretName"
                                         }
                                     }
                                 }
                             }
                         }
                     },
                     Backends = new [] { new BackendProperty {
                         VirtualService = new VirtualServiceBackendProperty {
                             ClientPolicy = new ClientPolicyProperty {
                                 Tls = new ClientPolicyTlsProperty {
                                     Certificate = new ClientTlsCertificateProperty {
                                         File = new ListenerTlsFileCertificateProperty {
                                             CertificateChain = "certificateChain",
                                             PrivateKey = "privateKey"
                                         },
                                         Sds = new ListenerTlsSdsCertificateProperty {
                                             SecretName = "secretName"
                                         }
                                     },
                                     Enforce = false,
                                     Ports = new [] { 123 },
                                     Validation = new TlsValidationContextProperty {
                                         SubjectAlternativeNames = new SubjectAlternativeNamesProperty {
                                             Match = new SubjectAlternativeNameMatchersProperty {
                                                 Exact = new [] { "exact" }
                                             }
                                         },
                                         Trust = new TlsValidationContextTrustProperty {
                                             Acm = new TlsValidationContextAcmTrustProperty {
                                                 CertificateAuthorityArns = new [] { "certificateAuthorityArns" }
                                             },
                                             File = new TlsValidationContextFileTrustProperty {
                                                 CertificateChain = "certificateChain"
                                             },
                                             Sds = new TlsValidationContextSdsTrustProperty {
                                                 SecretName = "secretName"
                                             }
                                         }
                                     }
                                 }
                             },
                             VirtualServiceName = "virtualServiceName"
                         }
                     } },
                     Listeners = new [] { new ListenerProperty {
                         ConnectionPool = new VirtualNodeConnectionPoolProperty {
                             Grpc = new VirtualNodeGrpcConnectionPoolProperty {
                                 MaxRequests = 123
                             },
                             Http = new VirtualNodeHttpConnectionPoolProperty {
                                 MaxConnections = 123,
                                 MaxPendingRequests = 123
                             },
                             Http2 = new VirtualNodeHttp2ConnectionPoolProperty {
                                 MaxRequests = 123
                             },
                             Tcp = new VirtualNodeTcpConnectionPoolProperty {
                                 MaxConnections = 123
                             }
                         },
                         HealthCheck = new HealthCheckProperty {
                             HealthyThreshold = 123,
                             IntervalMillis = 123,
                             Path = "path",
                             Port = 123,
                             Protocol = "protocol",
                             TimeoutMillis = 123,
                             UnhealthyThreshold = 123
                         },
                         OutlierDetection = new OutlierDetectionProperty {
                             BaseEjectionDuration = new DurationProperty {
                                 Unit = "unit",
                                 Value = 123
                             },
                             Interval = new DurationProperty {
                                 Unit = "unit",
                                 Value = 123
                             },
                             MaxEjectionPercent = 123,
                             MaxServerErrors = 123
                         },
                         PortMapping = new PortMappingProperty {
                             Port = 123,
                             Protocol = "protocol"
                         },
                         Timeout = new ListenerTimeoutProperty {
                             Grpc = new GrpcTimeoutProperty {
                                 Idle = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 },
                                 PerRequest = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 }
                             },
                             Http = new HttpTimeoutProperty {
                                 Idle = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 },
                                 PerRequest = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 }
                             },
                             Http2 = new HttpTimeoutProperty {
                                 Idle = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 },
                                 PerRequest = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 }
                             },
                             Tcp = new TcpTimeoutProperty {
                                 Idle = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 }
                             }
                         },
                         Tls = new ListenerTlsProperty {
                             Certificate = new ListenerTlsCertificateProperty {
                                 Acm = new ListenerTlsAcmCertificateProperty {
                                     CertificateArn = "certificateArn"
                                 },
                                 File = new ListenerTlsFileCertificateProperty {
                                     CertificateChain = "certificateChain",
                                     PrivateKey = "privateKey"
                                 },
                                 Sds = new ListenerTlsSdsCertificateProperty {
                                     SecretName = "secretName"
                                 }
                             },
                             Mode = "mode",
                             Validation = new ListenerTlsValidationContextProperty {
                                 SubjectAlternativeNames = new SubjectAlternativeNamesProperty {
                                     Match = new SubjectAlternativeNameMatchersProperty {
                                         Exact = new [] { "exact" }
                                     }
                                 },
                                 Trust = new ListenerTlsValidationContextTrustProperty {
                                     File = new TlsValidationContextFileTrustProperty {
                                         CertificateChain = "certificateChain"
                                     },
                                     Sds = new TlsValidationContextSdsTrustProperty {
                                         SecretName = "secretName"
                                     }
                                 }
                             }
                         }
                     } },
                     Logging = new LoggingProperty {
                         AccessLog = new AccessLogProperty {
                             File = new FileAccessLogProperty {
                                 Format = new LoggingFormatProperty {
                                     Json = new [] { new JsonFormatRefProperty {
                                         Key = "key",
                                         Value = "value"
                                     } },
                                     Text = "text"
                                 },
                                 Path = "path"
                             }
                         }
                     },
                     ServiceDiscovery = new ServiceDiscoveryProperty {
                         AwsCloudMap = new AwsCloudMapServiceDiscoveryProperty {
                             Attributes = new [] { new AwsCloudMapInstanceAttributeProperty {
                                 Key = "key",
                                 Value = "value"
                             } },
                             IpPreference = "ipPreference",
                             NamespaceName = "namespaceName",
                             ServiceName = "serviceName"
                         },
                         Dns = new DnsServiceDiscoveryProperty {
                             Hostname = "hostname",
                             IpPreference = "ipPreference",
                             ResponseType = "responseType"
                         }
                     }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VirtualNodeName = "virtualNodeName"
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Strategy

Creates a virtual node within a service mesh.

protected virtual PropertyMergeStrategy Strategy { get; }
Property Value

PropertyMergeStrategy

Remarks

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 <code>APPMESH_RESOURCE_ARN</code> when Envoy is referring to itself in metrics and traces. You can override this behavior by setting the <code>APPMESH_RESOURCE_CLUSTER</code> 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 aboutApp Mesh Envoy variables, see Envoy image in the AWS App Mesh User Guide.

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

CloudformationResource: AWS::AppMesh::VirtualNode

Mixin: true

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.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.AppMesh.Mixins;

             var cfnVirtualNodePropsMixin = new CfnVirtualNodePropsMixin(new CfnVirtualNodeMixinProps {
                 MeshName = "meshName",
                 MeshOwner = "meshOwner",
                 Spec = new VirtualNodeSpecProperty {
                     BackendDefaults = new BackendDefaultsProperty {
                         ClientPolicy = new ClientPolicyProperty {
                             Tls = new ClientPolicyTlsProperty {
                                 Certificate = new ClientTlsCertificateProperty {
                                     File = new ListenerTlsFileCertificateProperty {
                                         CertificateChain = "certificateChain",
                                         PrivateKey = "privateKey"
                                     },
                                     Sds = new ListenerTlsSdsCertificateProperty {
                                         SecretName = "secretName"
                                     }
                                 },
                                 Enforce = false,
                                 Ports = new [] { 123 },
                                 Validation = new TlsValidationContextProperty {
                                     SubjectAlternativeNames = new SubjectAlternativeNamesProperty {
                                         Match = new SubjectAlternativeNameMatchersProperty {
                                             Exact = new [] { "exact" }
                                         }
                                     },
                                     Trust = new TlsValidationContextTrustProperty {
                                         Acm = new TlsValidationContextAcmTrustProperty {
                                             CertificateAuthorityArns = new [] { "certificateAuthorityArns" }
                                         },
                                         File = new TlsValidationContextFileTrustProperty {
                                             CertificateChain = "certificateChain"
                                         },
                                         Sds = new TlsValidationContextSdsTrustProperty {
                                             SecretName = "secretName"
                                         }
                                     }
                                 }
                             }
                         }
                     },
                     Backends = new [] { new BackendProperty {
                         VirtualService = new VirtualServiceBackendProperty {
                             ClientPolicy = new ClientPolicyProperty {
                                 Tls = new ClientPolicyTlsProperty {
                                     Certificate = new ClientTlsCertificateProperty {
                                         File = new ListenerTlsFileCertificateProperty {
                                             CertificateChain = "certificateChain",
                                             PrivateKey = "privateKey"
                                         },
                                         Sds = new ListenerTlsSdsCertificateProperty {
                                             SecretName = "secretName"
                                         }
                                     },
                                     Enforce = false,
                                     Ports = new [] { 123 },
                                     Validation = new TlsValidationContextProperty {
                                         SubjectAlternativeNames = new SubjectAlternativeNamesProperty {
                                             Match = new SubjectAlternativeNameMatchersProperty {
                                                 Exact = new [] { "exact" }
                                             }
                                         },
                                         Trust = new TlsValidationContextTrustProperty {
                                             Acm = new TlsValidationContextAcmTrustProperty {
                                                 CertificateAuthorityArns = new [] { "certificateAuthorityArns" }
                                             },
                                             File = new TlsValidationContextFileTrustProperty {
                                                 CertificateChain = "certificateChain"
                                             },
                                             Sds = new TlsValidationContextSdsTrustProperty {
                                                 SecretName = "secretName"
                                             }
                                         }
                                     }
                                 }
                             },
                             VirtualServiceName = "virtualServiceName"
                         }
                     } },
                     Listeners = new [] { new ListenerProperty {
                         ConnectionPool = new VirtualNodeConnectionPoolProperty {
                             Grpc = new VirtualNodeGrpcConnectionPoolProperty {
                                 MaxRequests = 123
                             },
                             Http = new VirtualNodeHttpConnectionPoolProperty {
                                 MaxConnections = 123,
                                 MaxPendingRequests = 123
                             },
                             Http2 = new VirtualNodeHttp2ConnectionPoolProperty {
                                 MaxRequests = 123
                             },
                             Tcp = new VirtualNodeTcpConnectionPoolProperty {
                                 MaxConnections = 123
                             }
                         },
                         HealthCheck = new HealthCheckProperty {
                             HealthyThreshold = 123,
                             IntervalMillis = 123,
                             Path = "path",
                             Port = 123,
                             Protocol = "protocol",
                             TimeoutMillis = 123,
                             UnhealthyThreshold = 123
                         },
                         OutlierDetection = new OutlierDetectionProperty {
                             BaseEjectionDuration = new DurationProperty {
                                 Unit = "unit",
                                 Value = 123
                             },
                             Interval = new DurationProperty {
                                 Unit = "unit",
                                 Value = 123
                             },
                             MaxEjectionPercent = 123,
                             MaxServerErrors = 123
                         },
                         PortMapping = new PortMappingProperty {
                             Port = 123,
                             Protocol = "protocol"
                         },
                         Timeout = new ListenerTimeoutProperty {
                             Grpc = new GrpcTimeoutProperty {
                                 Idle = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 },
                                 PerRequest = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 }
                             },
                             Http = new HttpTimeoutProperty {
                                 Idle = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 },
                                 PerRequest = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 }
                             },
                             Http2 = new HttpTimeoutProperty {
                                 Idle = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 },
                                 PerRequest = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 }
                             },
                             Tcp = new TcpTimeoutProperty {
                                 Idle = new DurationProperty {
                                     Unit = "unit",
                                     Value = 123
                                 }
                             }
                         },
                         Tls = new ListenerTlsProperty {
                             Certificate = new ListenerTlsCertificateProperty {
                                 Acm = new ListenerTlsAcmCertificateProperty {
                                     CertificateArn = "certificateArn"
                                 },
                                 File = new ListenerTlsFileCertificateProperty {
                                     CertificateChain = "certificateChain",
                                     PrivateKey = "privateKey"
                                 },
                                 Sds = new ListenerTlsSdsCertificateProperty {
                                     SecretName = "secretName"
                                 }
                             },
                             Mode = "mode",
                             Validation = new ListenerTlsValidationContextProperty {
                                 SubjectAlternativeNames = new SubjectAlternativeNamesProperty {
                                     Match = new SubjectAlternativeNameMatchersProperty {
                                         Exact = new [] { "exact" }
                                     }
                                 },
                                 Trust = new ListenerTlsValidationContextTrustProperty {
                                     File = new TlsValidationContextFileTrustProperty {
                                         CertificateChain = "certificateChain"
                                     },
                                     Sds = new TlsValidationContextSdsTrustProperty {
                                         SecretName = "secretName"
                                     }
                                 }
                             }
                         }
                     } },
                     Logging = new LoggingProperty {
                         AccessLog = new AccessLogProperty {
                             File = new FileAccessLogProperty {
                                 Format = new LoggingFormatProperty {
                                     Json = new [] { new JsonFormatRefProperty {
                                         Key = "key",
                                         Value = "value"
                                     } },
                                     Text = "text"
                                 },
                                 Path = "path"
                             }
                         }
                     },
                     ServiceDiscovery = new ServiceDiscoveryProperty {
                         AwsCloudMap = new AwsCloudMapServiceDiscoveryProperty {
                             Attributes = new [] { new AwsCloudMapInstanceAttributeProperty {
                                 Key = "key",
                                 Value = "value"
                             } },
                             IpPreference = "ipPreference",
                             NamespaceName = "namespaceName",
                             ServiceName = "serviceName"
                         },
                         Dns = new DnsServiceDiscoveryProperty {
                             Hostname = "hostname",
                             IpPreference = "ipPreference",
                             ResponseType = "responseType"
                         }
                     }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VirtualNodeName = "virtualNodeName"
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

public override IConstruct ApplyTo(IConstruct construct)
Parameters
construct IConstruct
Returns

IConstruct

Overrides
Mixin.ApplyTo(IConstruct)
Remarks

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 <code>APPMESH_RESOURCE_ARN</code> when Envoy is referring to itself in metrics and traces. You can override this behavior by setting the <code>APPMESH_RESOURCE_CLUSTER</code> 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 aboutApp Mesh Envoy variables, see Envoy image in the AWS App Mesh User Guide.

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

CloudformationResource: AWS::AppMesh::VirtualNode

Mixin: true

ExampleMetadata: fixture=_generated

Supports(IConstruct)

Check if this mixin supports the given construct.

public override bool Supports(IConstruct construct)
Parameters
construct IConstruct
Returns

bool

Overrides
Mixin.Supports(IConstruct)
Remarks

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 <code>APPMESH_RESOURCE_ARN</code> when Envoy is referring to itself in metrics and traces. You can override this behavior by setting the <code>APPMESH_RESOURCE_CLUSTER</code> 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 aboutApp Mesh Envoy variables, see Envoy image in the AWS App Mesh User Guide.

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

CloudformationResource: AWS::AppMesh::VirtualNode

Mixin: true

ExampleMetadata: fixture=_generated

Implements

IMixin
Back to top Generated by DocFX