@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 Amazon Web Services-provided keys, some of which have specific allowed values. These keys and their associated values are as follows:
ApplicationConfiguration
ApplicationConfigurationSchema
Automation
ChangeCalendar
Command
Package
Policy
Session
Note that only one Owner
can be specified in a request. For example: Key=Owner,Values=Self
.
Amazon
Private
Public
Self
ThirdParty
Linux
Windows
Name
is another Amazon Web Services-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 Amazon Web Services 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
Amazon Web Services-provided key. For a list of valid resource type
values that can be used with this key, see Amazon Web
Services resource and property types reference in the 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-value pair, use the format Key=tag:tagName,Values=valueName
.
For example, if you created a key called region and are using the Amazon Web Services CLI to call the
list-documents
command:
aws ssm list-documents --filters Key=tag:region,Values=east,west Key=Owner,Values=Self
Constructor and Description |
---|
DocumentKeyValuesFilter() |
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.
|
public void setKey(String key)
The name of the filter key.
key
- The name of the filter key.public String getKey()
The name of the filter key.
public DocumentKeyValuesFilter withKey(String key)
The name of the filter key.
key
- The name of the filter key.public List<String> getValues()
The value for the filter key.
public void setValues(Collection<String> values)
The value for the filter key.
values
- The value for the filter key.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.
values
- The value for the filter key.public DocumentKeyValuesFilter withValues(Collection<String> values)
The value for the filter key.
values
- The value for the filter key.public String toString()
toString
in class Object
Object.toString()
public DocumentKeyValuesFilter clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.