Show / Hide Table of Contents

Class Tag

The Tag Aspect will handle adding a tag to this node and cascading tags to children.

Inheritance
object
Tag
Implements
IAspect
Namespace: Amazon.CDK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class Tag : DeputyBase, IAspect
Syntax (vb)
Public Class Tag Inherits DeputyBase Implements IAspect
Remarks

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;

            var tag = new Tag("key", "value", new TagProps {
                ApplyToLaunchedInstances = false,
                ExcludeResourceTypes = new [] { "excludeResourceTypes" },
                IncludeResourceTypes = new [] { "includeResourceTypes" },
                Priority = 123
            });

Synopsis

Constructors

Tag(string, string, ITagProps?)

The Tag Aspect will handle adding a tag to this node and cascading tags to children.

Properties

Key

The string key for the tag.

Props

The Tag Aspect will handle adding a tag to this node and cascading tags to children.

Value

The string value of the tag.

Methods

ApplyTag(ITaggable)

The Tag Aspect will handle adding a tag to this node and cascading tags to children.

ApplyTagV2(ITaggableV2)

The Tag Aspect will handle adding a tag to this node and cascading tags to children.

Visit(IConstruct)

All aspects can visit an IConstruct.

Constructors

Tag(string, string, ITagProps?)

The Tag Aspect will handle adding a tag to this node and cascading tags to children.

public Tag(string key, string value, ITagProps? props = null)
Parameters
key string

The string key for the tag.

value string

The string key for the tag.

props ITagProps

The string key for the tag.

Remarks

ExampleMetadata: fixture=_generated

Properties

Key

The string key for the tag.

public virtual string Key { get; }
Property Value

string

Remarks

ExampleMetadata: fixture=_generated

Props

The Tag Aspect will handle adding a tag to this node and cascading tags to children.

protected virtual ITagProps Props { get; }
Property Value

ITagProps

Remarks

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;

            var tag = new Tag("key", "value", new TagProps {
                ApplyToLaunchedInstances = false,
                ExcludeResourceTypes = new [] { "excludeResourceTypes" },
                IncludeResourceTypes = new [] { "includeResourceTypes" },
                Priority = 123
            });

Value

The string value of the tag.

public virtual string Value { get; }
Property Value

string

Remarks

ExampleMetadata: fixture=_generated

Methods

ApplyTag(ITaggable)

The Tag Aspect will handle adding a tag to this node and cascading tags to children.

protected virtual void ApplyTag(ITaggable resource)
Parameters
resource ITaggable
Remarks

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;

            var tag = new Tag("key", "value", new TagProps {
                ApplyToLaunchedInstances = false,
                ExcludeResourceTypes = new [] { "excludeResourceTypes" },
                IncludeResourceTypes = new [] { "includeResourceTypes" },
                Priority = 123
            });

ApplyTagV2(ITaggableV2)

The Tag Aspect will handle adding a tag to this node and cascading tags to children.

protected virtual void ApplyTagV2(ITaggableV2 resource)
Parameters
resource ITaggableV2
Remarks

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;

            var tag = new Tag("key", "value", new TagProps {
                ApplyToLaunchedInstances = false,
                ExcludeResourceTypes = new [] { "excludeResourceTypes" },
                IncludeResourceTypes = new [] { "includeResourceTypes" },
                Priority = 123
            });

Visit(IConstruct)

All aspects can visit an IConstruct.

public virtual void Visit(IConstruct construct)
Parameters
construct IConstruct
Remarks

ExampleMetadata: fixture=_generated

Implements

IAspect
Back to top Generated by DocFX