class Tags
Language | Type name |
---|---|
![]() | Amazon.CDK.Tags |
![]() | github.com/aws/aws-cdk-go/awscdk/v2#Tags |
![]() | software.amazon.awscdk.Tags |
![]() | aws_cdk.Tags |
![]() | aws-cdk-lib » Tags |
Manages AWS tags for all resources within a construct scope.
Example
declare const mesh: appmesh.Mesh;
declare const service: cloudmap.Service;
const node = new appmesh.VirtualNode(this, 'node', {
mesh,
serviceDiscovery: appmesh.ServiceDiscovery.cloudMap(service),
listeners: [appmesh.VirtualNodeListener.http({
port: 8080,
healthCheck: appmesh.HealthCheck.http({
healthyThreshold: 3,
interval: Duration.seconds(5),
path: '/ping',
timeout: Duration.seconds(2),
unhealthyThreshold: 2,
}),
timeout: {
idle: Duration.seconds(5),
},
})],
backendDefaults: {
tlsClientPolicy: {
validation: {
trust: appmesh.TlsValidationTrust.file('/keys/local_cert_chain.pem'),
},
},
},
accessLog: appmesh.AccessLog.fromFilePath('/dev/stdout'),
});
cdk.Tags.of(node).add('Environment', 'Dev');
Methods
Name | Description |
---|---|
add(key, value, props?) | Add tags to the node of a construct and all its the taggable children. |
remove(key, props?) | remove tags to the node of a construct and all its the taggable children. |
static of(scope) | Returns the tags API for this scope. |
add(key, value, props?)
public add(key: string, value: string, props?: TagProps): void
Parameters
- key
string
- value
string
- props
Tag
Props
Add tags to the node of a construct and all its the taggable children.
Tagging and CloudFormation Stacks
If the feature flag @aws-cdk/core:explicitStackTags
is set to true
(recommended modern behavior), Stacks will not automatically be tagged.
Stack tags should be configured on Stacks directly (preferred), or
you must explicitly include the resource type aws:cdk:stack
in the
includeResourceTypes
array.
If the feature flag is set to false
(legacy behavior) then both Stacks
and resources in the indicated scope will both be tagged by default, which
leads to tags being applied twice (once in the template, and then once
again automatically by CloudFormation as part of the stack deployment).
That behavior leads to loss of control as excludeResourceTypes
will
prevent tags from appearing in the template, but they will still be
applied to the Stack and hence CloudFormation will still apply them
to the resource.
remove(key, props?)
public remove(key: string, props?: TagProps): void
Parameters
- key
string
- props
Tag
Props
remove tags to the node of a construct and all its the taggable children.
static of(scope)
public static of(scope: IConstruct): Tags
Parameters
- scope
IConstruct
— The scope.
Returns
Returns the tags API for this scope.