#include <TagResourceRequest.h>

Inheritance diagram for Aws::SecretsManager::Model::TagResourceRequest:

Public Member Functions
	TagResourceRequest ()

virtual const char *	GetServiceRequestName () const override

Aws::String	SerializePayload () const override

Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override

const Aws::String &	GetSecretId () const

bool	SecretIdHasBeenSet () const

void	SetSecretId (const Aws::String &value)

void	SetSecretId (Aws::String &&value)

void	SetSecretId (const char *value)

TagResourceRequest &	WithSecretId (const Aws::String &value)

TagResourceRequest &	WithSecretId (Aws::String &&value)

TagResourceRequest &	WithSecretId (const char *value)

const Aws::Vector< Tag > &	GetTags () const

bool	TagsHasBeenSet () const

void	SetTags (const Aws::Vector< Tag > &value)

void	SetTags (Aws::Vector< Tag > &&value)

TagResourceRequest &	WithTags (const Aws::Vector< Tag > &value)

TagResourceRequest &	WithTags (Aws::Vector< Tag > &&value)

TagResourceRequest &	AddTags (const Tag &value)

TagResourceRequest &	AddTags (Tag &&value)

Public Member Functions inherited from Aws::SecretsManager::SecretsManagerRequest
virtual	~SecretsManagerRequest ()

void	AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const

Aws::Http::HeaderValueCollection	GetHeaders () const override

Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
	AmazonSerializableWebServiceRequest ()

virtual	~AmazonSerializableWebServiceRequest ()

std::shared_ptr< Aws::IOStream >	GetBody () const override

Public Member Functions inherited from Aws::AmazonWebServiceRequest
	AmazonWebServiceRequest ()

virtual	~AmazonWebServiceRequest ()=default

virtual void	AddQueryStringParameters (Aws::Http::URI &uri) const

virtual void	PutToPresignedUrl (Aws::Http::URI &uri) const

virtual bool	IsStreaming () const

virtual bool	IsEventStreamRequest () const

virtual bool	SignBody () const

virtual bool	IsChunked () const

virtual void	SetRequestSignedHandler (const RequestSignedHandler &handler)

virtual const RequestSignedHandler &	GetRequestSignedHandler () const

const Aws::IOStreamFactory &	GetResponseStreamFactory () const

void	SetResponseStreamFactory (const Aws::IOStreamFactory &factory)

virtual void	SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

virtual void	SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

virtual void	SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

virtual void	SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

virtual void	SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

virtual void	SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

virtual void	SetRequestRetryHandler (const RequestRetryHandler &handler)

virtual void	SetRequestRetryHandler (RequestRetryHandler &&handler)

virtual const Aws::Http::DataReceivedEventHandler &	GetDataReceivedEventHandler () const

virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const

virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const

virtual const RequestRetryHandler &	GetRequestRetryHandler () const

virtual bool	ShouldComputeContentMd5 () const

Additional Inherited Members
Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void	DumpBodyToUrl (Aws::Http::URI &uri) const

Detailed Description

Definition at line 23 of file TagResourceRequest.h.

Constructor & Destructor Documentation

◆ TagResourceRequest()

Aws::SecretsManager::Model::TagResourceRequest::TagResourceRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

TagResourceRequest& Aws::SecretsManager::Model::TagResourceRequest::AddTags ( const Tag & value )

inline

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"[,…]

Definition at line 298 of file TagResourceRequest.h.

◆ AddTags() [2/2]

TagResourceRequest& Aws::SecretsManager::Model::TagResourceRequest::AddTags ( Tag && value )

inline

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"[,…]

Definition at line 310 of file TagResourceRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SecretsManager::Model::TagResourceRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::SecretsManager::SecretsManagerRequest.

◆ GetSecretId()

const Aws::String& Aws::SecretsManager::Model::TagResourceRequest::GetSecretId ( ) const

inline

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.

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 ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

Definition at line 59 of file TagResourceRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::SecretsManager::Model::TagResourceRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file TagResourceRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::SecretsManager::Model::TagResourceRequest::GetTags ( ) const

inline

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"[,…]

Definition at line 226 of file TagResourceRequest.h.

◆ SecretIdHasBeenSet()

bool Aws::SecretsManager::Model::TagResourceRequest::SecretIdHasBeenSet ( ) const

inline

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.

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 ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

Definition at line 81 of file TagResourceRequest.h.

◆ SerializePayload()

Aws::String Aws::SecretsManager::Model::TagResourceRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetSecretId() [1/3]

void Aws::SecretsManager::Model::TagResourceRequest::SetSecretId ( Aws::String && value )

inline

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.

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 ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

Definition at line 125 of file TagResourceRequest.h.

◆ SetSecretId() [2/3]

void Aws::SecretsManager::Model::TagResourceRequest::SetSecretId ( const Aws::String & value )

inline

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.

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 ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

Definition at line 103 of file TagResourceRequest.h.

◆ SetSecretId() [3/3]

void Aws::SecretsManager::Model::TagResourceRequest::SetSecretId ( const char * value )

inline

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.

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 ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

Definition at line 147 of file TagResourceRequest.h.

◆ SetTags() [1/2]

void Aws::SecretsManager::Model::TagResourceRequest::SetTags ( Aws::Vector< Tag > && value )

inline

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"[,…]

Definition at line 262 of file TagResourceRequest.h.

◆ SetTags() [2/2]

void Aws::SecretsManager::Model::TagResourceRequest::SetTags ( const Aws::Vector< Tag > & value )

inline

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"[,…]

Definition at line 250 of file TagResourceRequest.h.

◆ TagsHasBeenSet()

bool Aws::SecretsManager::Model::TagResourceRequest::TagsHasBeenSet ( ) const

inline

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"[,…]

Definition at line 238 of file TagResourceRequest.h.

◆ WithSecretId() [1/3]

TagResourceRequest& Aws::SecretsManager::Model::TagResourceRequest::WithSecretId ( Aws::String && value )

inline

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.

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 ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

Definition at line 191 of file TagResourceRequest.h.

◆ WithSecretId() [2/3]

TagResourceRequest& Aws::SecretsManager::Model::TagResourceRequest::WithSecretId ( const Aws::String & value )

inline

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.

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 ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

Definition at line 169 of file TagResourceRequest.h.

◆ WithSecretId() [3/3]

TagResourceRequest& Aws::SecretsManager::Model::TagResourceRequest::WithSecretId ( const char * value )

inline

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.

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 ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

Definition at line 213 of file TagResourceRequest.h.

◆ WithTags() [1/2]

TagResourceRequest& Aws::SecretsManager::Model::TagResourceRequest::WithTags ( Aws::Vector< Tag > && value )

inline

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"[,…]

Definition at line 286 of file TagResourceRequest.h.

◆ WithTags() [2/2]

TagResourceRequest& Aws::SecretsManager::Model::TagResourceRequest::WithTags ( const Aws::Vector< Tag > & value )

inline

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"[,…]

Definition at line 274 of file TagResourceRequest.h.

The documentation for this class was generated from the following file:

aws-cpp-sdk-secretsmanager/include/aws/secretsmanager/model/TagResourceRequest.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TagResourceRequest()

Member Function Documentation

◆ AddTags() [1/2]

◆ AddTags() [2/2]

◆ GetRequestSpecificHeaders()

◆ GetSecretId()

◆ GetServiceRequestName()

◆ GetTags()

◆ SecretIdHasBeenSet()

◆ SerializePayload()

◆ SetSecretId() [1/3]

◆ SetSecretId() [2/3]

◆ SetSecretId() [3/3]

◆ SetTags() [1/2]

◆ SetTags() [2/2]

◆ TagsHasBeenSet()

◆ WithSecretId() [1/3]

◆ WithSecretId() [2/3]

◆ WithSecretId() [3/3]

◆ WithTags() [1/2]

◆ WithTags() [2/2]