Class: AWSCDK::DevOpsGuru::CfnResourceCollection::TagCollectionProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::DevOpsGuru::CfnResourceCollection::TagCollectionProperty

Defined in:

dev_ops_guru/cfn_resource_collection.rb

Overview

A collection of AWS tags.

Tags help you identify and organize your AWS resources. Many AWS services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an AWS Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

Each AWS tag has two parts.

• A tag key (for example, CostCenter , Environment , Project , or Secret ). Tag keys are case-sensitive.
• A field known as a tag value (for example, 111122223333 , Production , or a team name). Omitting the tag value is the same as using an empty string. Like tag keys , tag values are case-sensitive. The tag value is a required property when AppBoundaryKey is specified.

Together these are known as key - value pairs.

The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru- . The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application . When you create a key , the case of characters in the key can be whatever you choose. After you create a key , it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS , and these act as two different keys . Possible key / value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-resourcecollection-tagcollection.html

Instance Attribute Summary

• #app_boundary_key ⇒ String^? readonly

  An AWS tag key that is used to identify the AWS resources that DevOps Guru analyzes.

• #tag_values ⇒ Array<String>^? readonly

  The values in an AWS tag collection.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(app_boundary_key: nil, tag_values: nil) ⇒ TagCollectionProperty constructor

  A new instance of TagCollectionProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(app_boundary_key: nil, tag_values: nil) ⇒ TagCollectionProperty

Returns a new instance of TagCollectionProperty.

Parameters:

• app_boundary_key (String, nil) (defaults to: nil) —

  An AWS tag key that is used to identify the AWS resources that DevOps Guru analyzes.

• tag_values (Array<String>, nil) (defaults to: nil) —

  The values in an AWS tag collection.

# File 'dev_ops_guru/cfn_resource_collection.rb', line 608

def initialize(app_boundary_key: nil, tag_values: nil)
  @app_boundary_key = app_boundary_key
  Jsii::Type.check_type(@app_boundary_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "appBoundaryKey") unless @app_boundary_key.nil?
  @tag_values = tag_values
  Jsii::Type.check_type(@tag_values, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagValues") unless @tag_values.nil?
end

Instance Attribute Details

#app_boundary_key ⇒ String^? (readonly)

An AWS tag key that is used to identify the AWS resources that DevOps Guru analyzes.

All AWS resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

When you create a key , the case of characters in the key can be whatever you choose. After you create a key , it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS , and these act as two different keys . Possible key / value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-resourcecollection-tagcollection.html#cfn-devopsguru-resourcecollection-tagcollection-appboundarykey

# File 'dev_ops_guru/cfn_resource_collection.rb', line 623

def app_boundary_key
  @app_boundary_key
end

#tag_values ⇒ Array<String>^? (readonly)

The values in an AWS tag collection.

The tag's value is a field used to associate a string with the tag key (for example, 111122223333 , Production , or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys , tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value. The tag value is a required property when AppBoundaryKey is specified.

Returns:

• (Array<String>, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-resourcecollection-tagcollection.html#cfn-devopsguru-resourcecollection-tagcollection-tagvalues

# File 'dev_ops_guru/cfn_resource_collection.rb', line 630

def tag_values
  @tag_values
end

Class Method Details

.jsii_properties ⇒ Object

# File 'dev_ops_guru/cfn_resource_collection.rb', line 632

def self.jsii_properties
  {
    :app_boundary_key => "appBoundaryKey",
    :tag_values => "tagValues",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'dev_ops_guru/cfn_resource_collection.rb', line 639

def to_jsii
  result = {}
  result.merge!({
    "appBoundaryKey" => @app_boundary_key,
    "tagValues" => @tag_values,
  })
  result.compact
end