Skip to content
v2.277.0

TagProperty Struct ​

A key-value pair associated with an ECS Target of an EventBridge rule.

The tag will be propagated to ECS by EventBridge when starting an ECS task based on a matched event.

Currently, tags are only available when using ECS with EventBridge .

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_events as events } from 'aws-cdk-lib';
const tagProperty: events.CfnRule.TagProperty = {
  key: 'key',
  value: 'value',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_events as events

tag_property = events.CfnRule.TagProperty(
    key="key",
    value="value"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.events.*;

TagProperty tagProperty = TagProperty.builder()
        .key("key")
        .value("value")
        .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.AWS.Events;

var tagProperty = new TagProperty {
    Key = "key",
    Value = "value"
};
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 "github.com/aws/aws-cdk-go/awscdk"

tagProperty := &TagProperty{
	Key: jsii.String("key"),
	Value: jsii.String("value"),
}

Properties ​

keyoptionalstringkeyoptionalstrkeyoptionalStringKeyoptionalstringKeyoptional*string#
A string you can use to assign a value.

The combination of tag keys and values can help you organize and categorize your resources.

valueoptionalstringvalueoptionalstrvalueoptionalStringValueoptionalstringValueoptional*string#
The value for the specified tag key.