aws-cdk-lib.aws_appmesh.IVirtualService

interface IVirtualService

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

Implemented by VirtualService

Obtainable from VirtualService.fromVirtualServiceArn(), VirtualService.fromVirtualServiceAttributes()

Represents the interface which all VirtualService based classes MUST implement.

Properties

NameTypeDescription
envResourceEnvironmentThe environment this resource belongs to.
meshIMeshThe Mesh which the VirtualService belongs to.
nodeNodeThe tree node.
stackStackThe stack in which this resource is defined.
virtualServiceArnstringThe Amazon Resource Name (ARN) for the virtual service.
virtualServiceNamestringThe name of the VirtualService.

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


mesh

Type: IMesh

The Mesh which the VirtualService belongs to.


node

Type: Node

The tree node.


stack

Type: Stack

The stack in which this resource is defined.


virtualServiceArn

Type: string

The Amazon Resource Name (ARN) for the virtual service.


virtualServiceName

Type: string

The name of the VirtualService.

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

Apply the given removal policy to this resource.

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).