com.amazonaws.services.cognitoidentityprovider.model

Class TagResourceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.TagResourceRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class TagResourceRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable

Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool, one for testing and another for production, you might assign an Environment tag key to both user pools. The value of this key might be Test for one user pool, and Production for the other.

Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an Identity and Access Management policy, you can constrain permissions for user pools based on specific tags or tag values.

You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TagResourceRequest()

Method Summary

Modifier and Type	Method and Description
TagResourceRequest	addTagsEntry(java.lang.String key, java.lang.String value) The tags to assign to the user pool.
TagResourceRequest	clearTagsEntries() Removes all the entries added into Tags.
boolean	equals(java.lang.Object obj)
java.lang.String	getResourceArn() The Amazon Resource Name (ARN) of the user pool to assign the tags to.
java.util.Map<java.lang.String,java.lang.String>	getTags() The tags to assign to the user pool.
int	hashCode()
void	setResourceArn(java.lang.String resourceArn) The Amazon Resource Name (ARN) of the user pool to assign the tags to.
void	setTags(java.util.Map<java.lang.String,java.lang.String> tags) The tags to assign to the user pool.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
TagResourceRequest	withResourceArn(java.lang.String resourceArn) The Amazon Resource Name (ARN) of the user pool to assign the tags to.
TagResourceRequest	withTags(java.util.Map<java.lang.String,java.lang.String> tags) The tags to assign to the user pool.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TagResourceRequest

public TagResourceRequest()

Method Detail

getResourceArn

public java.lang.String getResourceArn()

The Amazon Resource Name (ARN) of the user pool to assign the tags to.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

Returns:

The Amazon Resource Name (ARN) of the user pool to assign the tags to.

setResourceArn

public void setResourceArn(java.lang.String resourceArn)

The Amazon Resource Name (ARN) of the user pool to assign the tags to.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

Parameters:

resourceArn -

The Amazon Resource Name (ARN) of the user pool to assign the tags to.

withResourceArn

public TagResourceRequest withResourceArn(java.lang.String resourceArn)

The Amazon Resource Name (ARN) of the user pool to assign the tags to.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

Parameters:

resourceArn -

The Amazon Resource Name (ARN) of the user pool to assign the tags to.

Returns:

A reference to this updated object so that method calls can be chained together.

getTags

public java.util.Map<java.lang.String,java.lang.String> getTags()

The tags to assign to the user pool.

Returns:

The tags to assign to the user pool.

setTags

public void setTags(java.util.Map<java.lang.String,java.lang.String> tags)

The tags to assign to the user pool.

Parameters:

tags -

The tags to assign to the user pool.

withTags

public TagResourceRequest withTags(java.util.Map<java.lang.String,java.lang.String> tags)

The tags to assign to the user pool.

Returns a reference to this object so that method calls can be chained together.

Parameters:

tags -

The tags to assign to the user pool.

Returns:

A reference to this updated object so that method calls can be chained together.

addTagsEntry

public TagResourceRequest addTagsEntry(java.lang.String key,
                                       java.lang.String value)

The tags to assign to the user pool.

The method adds a new key-value pair into Tags parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Tags.

value - The corresponding value of the entry to be added into Tags.

Returns:

A reference to this updated object so that method calls can be chained together.

clearTagsEntries

public TagResourceRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns a reference to this object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object