AWS CDK Reference

Appearance

v2.274.0

RemoveTag Class ​

The RemoveTag Aspect will handle removing tags from this node and children.

Source
core/lib/tag-aspect.ts
Type last changed
v2.81.0 · 25 May 2023

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
const removeTag = new cdk.RemoveTag('key', /* all optional props */ {
  applyToLaunchedInstances: false,
  excludeResourceTypes: ['excludeResourceTypes'],
  includeResourceTypes: ['includeResourceTypes'],
  priority: 123,
});
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk

remove_tag = cdk.RemoveTag("key",
    apply_to_launched_instances=False,
    exclude_resource_types=["excludeResourceTypes"],
    include_resource_types=["includeResourceTypes"],
    priority=123
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;

RemoveTag removeTag = RemoveTag.Builder.create("key")
        .applyToLaunchedInstances(false)
        .excludeResourceTypes(List.of("excludeResourceTypes"))
        .includeResourceTypes(List.of("includeResourceTypes"))
        .priority(123)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;

var removeTag = new RemoveTag("key", new TagProps {
    ApplyToLaunchedInstances = false,
    ExcludeResourceTypes = new [] { "excludeResourceTypes" },
    IncludeResourceTypes = new [] { "includeResourceTypes" },
    Priority = 123
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"

removeTag := cdk.NewRemoveTag(jsii.String("key"), &TagProps{
	ApplyToLaunchedInstances: jsii.Boolean(false),
	ExcludeResourceTypes: []*string{
		jsii.String("excludeResourceTypes"),
	},
	IncludeResourceTypes: []*string{
		jsii.String("includeResourceTypes"),
	},
	Priority: jsii.Number(123),
})

Initializer ​

ts
new RemoveTag(key: string, props?: TagProps)
python
RemoveTag(key: str, props: typing.Optional[TagProps] = None)
java
new RemoveTag(String key, TagProps props)
csharp
new RemoveTag(string key, TagProps? props = null)
go
NewRemoveTag(Key *string, Props TagProps)

Properties ​

keystringkeystrkeyStringKeystringKey*stringrequired#
The string key for the tag.

Methods ​

visit(construct: IConstruct): voiddef visit(self, construct: IConstruct) -> Nonepublic void visit(IConstruct construct)public void Visit(IConstruct construct)func Visit(Construct IConstruct)#
All aspects can visit an IConstruct.