com.amazonaws.services.simplesystemsmanagement.model

Class DocumentKeyValuesFilter

java.lang.Object

com.amazonaws.services.simplesystemsmanagement.model.DocumentKeyValuesFilter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DocumentKeyValuesFilter
extends Object
implements Serializable, Cloneable, StructuredPojo

One or more filters. Use a filter to return a more specific list of documents.

For keys, you can specify one or more tags that have been applied to a document.

You can also use AWS-provided keys, some of which have specific allowed values. These keys and their associated values are as follows:

DocumentType

• ApplicationConfiguration

• ApplicationConfigurationSchema

• Automation

• ChangeCalendar

• Command

• DeploymentStrategy

• Package

• Policy

• Session

Owner

Note that only one Owner can be specified in a request. For example: Key=Owner,Values=Self.

• Amazon

• Private

• Public

• Self

• ThirdParty

PlatformTypes

• Linux

• Windows

Name is another AWS-provided key. If you use Name as a key, you can use a name prefix to return a list of documents. For example, in the AWS CLI, to return a list of all documents that begin with Te, run the following command:

aws ssm list-documents --filters Key=Name,Values=Te

You can also use the TargetType AWS-provided key. For a list of valid resource type values that can be used with this key, see AWS resource and property types reference in the AWS CloudFormation User Guide.

If you specify more than two keys, only documents that are identified by all the tags are returned in the results. If you specify more than two values for a key, documents that are identified by any of the values are returned in the results.

To specify a custom key and value pair, use the format Key=tag:tagName,Values=valueName.

For example, if you created a key called region and are using the AWS CLI to call the list-documents command:

aws ssm list-documents --filters Key=tag:region,Values=east,west Key=Owner,Values=Self

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentKeyValuesFilter()

Method Summary

Modifier and Type	Method and Description
DocumentKeyValuesFilter	clone()
boolean	equals(Object obj)
String	getKey() The name of the filter key.
List<String>	getValues() The value for the filter key.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setKey(String key) The name of the filter key.
void	setValues(Collection<String> values) The value for the filter key.
String	toString() Returns a string representation of this object.
DocumentKeyValuesFilter	withKey(String key) The name of the filter key.
DocumentKeyValuesFilter	withValues(Collection<String> values) The value for the filter key.
DocumentKeyValuesFilter	withValues(String... values) The value for the filter key.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentKeyValuesFilter

public DocumentKeyValuesFilter()

Method Detail

setKey

public void setKey(String key)

The name of the filter key.

Parameters:

key - The name of the filter key.

getKey

public String getKey()

The name of the filter key.

Returns:

The name of the filter key.

withKey

public DocumentKeyValuesFilter withKey(String key)

The name of the filter key.

Parameters:

key - The name of the filter key.

Returns:

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

getValues

public List<String> getValues()

The value for the filter key.

Returns:

The value for the filter key.

setValues

public void setValues(Collection<String> values)

The value for the filter key.

Parameters:

values - The value for the filter key.

withValues

public DocumentKeyValuesFilter withValues(String... values)

The value for the filter key.

NOTE: This method appends the values to the existing list (if any). Use setValues(java.util.Collection) or withValues(java.util.Collection) if you want to override the existing values.

Parameters:

values - The value for the filter key.

Returns:

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

withValues

public DocumentKeyValuesFilter withValues(Collection<String> values)

The value for the filter key.

Parameters:

values - The value for the filter key.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DocumentKeyValuesFilter clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.