Class: Aws::SecretsManager::Types::TagResourceRequest

Inherits:

Struct

Object
Struct
Aws::SecretsManager::Types::TagResourceRequest

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-secretsmanager/types.rb

Overview

Note:

When making an API call, you may pass TagResourceRequest data as a hash:

{
  secret_id: "SecretIdType", # required
  tags: [ # required
    {
      key: "TagKeyType",
      value: "TagValueType",
    },
  ],
}

Instance Attribute Summary collapse

#secret_id ⇒ String

The identifier for the secret that you want to attach tags to.
#tags ⇒ Array<Types::Tag>

The tags to attach to the secret.

Instance Attribute Details

#secret_id ⇒ `String`

The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

<note markdown=“1”> If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

</note>

Returns:

(String)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1726

class TagResourceRequest < Struct.new(
  :secret_id,
  :tags)
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

The tags to attach to the secret. Each element in the list consists of a ‘Key` and a `Value`.

This parameter to the API requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters] in the *AWS CLI User Guide*. For the AWS CLI, you can also use the syntax: ‘–Tags Key=“Key1”,Value=“Value1”,Key=“Key2”,Value=“Value2”`

[1]: docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json