Interface ITagProps

Properties for a tag.

Namespace: Amazon.CDK

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ITagProps

Syntax (vb)

Public Interface 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 tagProps = new TagProps {
                ApplyToLaunchedInstances = false,
                ExcludeResourceTypes = new [] { "excludeResourceTypes" },
                IncludeResourceTypes = new [] { "includeResourceTypes" },
                Priority = 123
            };

Synopsis

Properties

ApplyToLaunchedInstances	Whether the tag should be applied to instances in an AutoScalingGroup.
ExcludeResourceTypes	An array of Resource Types that will not receive this tag.
IncludeResourceTypes	An array of Resource Types that will receive this tag.
Priority	Priority of the tag operation.

Properties

ApplyToLaunchedInstances

Whether the tag should be applied to instances in an AutoScalingGroup.

bool? ApplyToLaunchedInstances { get; }

Property Value

bool?

Remarks

Default: true

ExcludeResourceTypes

An array of Resource Types that will not receive this tag.

string[]? ExcludeResourceTypes { get; }

Property Value

string[]

Remarks

An empty array will allow this tag to be applied to all resources. A non-empty array will apply this tag only if the Resource type is not in this array.

Default: []

IncludeResourceTypes

An array of Resource Types that will receive this tag.

string[]? IncludeResourceTypes { get; }

Property Value

string[]

Remarks

An empty array will match any Resource. A non-empty array will apply this tag only to Resource types that are included in this array.

Default: []

Priority

Priority of the tag operation.

double? Priority { get; }

Property Value

double?

Remarks

Higher or equal priority tags will take precedence.

Setting priority will enable the user to control tags when they need to not follow the default precedence pattern of last applied and closest to the construct in the tree.

Default: Default priorities:

• 100 for SetTag
• 200 for RemoveTag
• 50 for tags added directly to CloudFormation resources