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",
    },
  ],
}

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#secret_id ⇒ String

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

The tags to attach to the secret as a JSON text string argument.

Instance Attribute Details

#secret_id ⇒ `String`

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

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See [Finding a secret from a partial ARN].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen

Returns:

(String)

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

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

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

The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a ‘Key` and a `Value`.

For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see [Specifying parameter values for the Amazon Web Services CLI] in the Amazon Web Services CLI User Guide.

[1]: docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html