com.amazonaws.services.simplesystemsmanagement.model

Class CreateAssociationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simplesystemsmanagement.model.CreateAssociationRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateAssociationRequest()

Method Summary

Modifier and Type	Method and Description
CreateAssociationRequest	addParametersEntry(String key, List<String> value)
CreateAssociationRequest	clearParametersEntries() Removes all the entries added into Parameters.
CreateAssociationRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getDocumentVersion() The document version you want to associate with the target(s).
String	getInstanceId() The instance ID.
String	getName() The name of the SSM document.
InstanceAssociationOutputLocation	getOutputLocation() An Amazon S3 bucket where you want to store the output details of the request.
Map<String,List<String>>	getParameters() The parameters for the documents runtime configuration.
String	getScheduleExpression() A cron expression when the association will be applied to the target(s).
List<Target>	getTargets() The targets (either instances or tags) for the association.
int	hashCode()
void	setDocumentVersion(String documentVersion) The document version you want to associate with the target(s).
void	setInstanceId(String instanceId) The instance ID.
void	setName(String name) The name of the SSM document.
void	setOutputLocation(InstanceAssociationOutputLocation outputLocation) An Amazon S3 bucket where you want to store the output details of the request.
void	setParameters(Map<String,List<String>> parameters) The parameters for the documents runtime configuration.
void	setScheduleExpression(String scheduleExpression) A cron expression when the association will be applied to the target(s).
void	setTargets(Collection<Target> targets) The targets (either instances or tags) for the association.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateAssociationRequest	withDocumentVersion(String documentVersion) The document version you want to associate with the target(s).
CreateAssociationRequest	withInstanceId(String instanceId) The instance ID.
CreateAssociationRequest	withName(String name) The name of the SSM document.
CreateAssociationRequest	withOutputLocation(InstanceAssociationOutputLocation outputLocation) An Amazon S3 bucket where you want to store the output details of the request.
CreateAssociationRequest	withParameters(Map<String,List<String>> parameters) The parameters for the documents runtime configuration.
CreateAssociationRequest	withScheduleExpression(String scheduleExpression) A cron expression when the association will be applied to the target(s).
CreateAssociationRequest	withTargets(Collection<Target> targets) The targets (either instances or tags) for the association.
CreateAssociationRequest	withTargets(Target... targets) The targets (either instances or tags) for the association.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateAssociationRequest

public CreateAssociationRequest()

Method Detail

setName

public void setName(String name)

The name of the SSM document.

Parameters:

name - The name of the SSM document.

getName

public String getName()

The name of the SSM document.

Returns:

The name of the SSM document.

withName

public CreateAssociationRequest withName(String name)

The name of the SSM document.

Parameters:

name - The name of the SSM document.

Returns:

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

setDocumentVersion

public void setDocumentVersion(String documentVersion)

The document version you want to associate with the target(s). Can be a specific version or the default version.

Parameters:

documentVersion - The document version you want to associate with the target(s). Can be a specific version or the default version.

getDocumentVersion

public String getDocumentVersion()

The document version you want to associate with the target(s). Can be a specific version or the default version.

Returns:

The document version you want to associate with the target(s). Can be a specific version or the default version.

withDocumentVersion

public CreateAssociationRequest withDocumentVersion(String documentVersion)

The document version you want to associate with the target(s). Can be a specific version or the default version.

Parameters:

documentVersion - The document version you want to associate with the target(s). Can be a specific version or the default version.

Returns:

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

setInstanceId

public void setInstanceId(String instanceId)

The instance ID.

Parameters:

instanceId - The instance ID.

getInstanceId

public String getInstanceId()

The instance ID.

Returns:

The instance ID.

withInstanceId

public CreateAssociationRequest withInstanceId(String instanceId)

The instance ID.

Parameters:

instanceId - The instance ID.

Returns:

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

getParameters

public Map<String,List<String>> getParameters()

The parameters for the documents runtime configuration.

Returns:

The parameters for the documents runtime configuration.

setParameters

public void setParameters(Map<String,List<String>> parameters)

The parameters for the documents runtime configuration.

Parameters:

parameters - The parameters for the documents runtime configuration.

withParameters

public CreateAssociationRequest withParameters(Map<String,List<String>> parameters)

The parameters for the documents runtime configuration.

Parameters:

parameters - The parameters for the documents runtime configuration.

Returns:

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

addParametersEntry

public CreateAssociationRequest addParametersEntry(String key,
                                                   List<String> value)

clearParametersEntries

public CreateAssociationRequest clearParametersEntries()

Removes all the entries added into Parameters.

Returns:

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

getTargets

public List<Target> getTargets()

The targets (either instances or tags) for the association. Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

Returns:

The targets (either instances or tags) for the association. Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

setTargets

public void setTargets(Collection<Target> targets)

The targets (either instances or tags) for the association. Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

Parameters:

targets - The targets (either instances or tags) for the association. Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

withTargets

public CreateAssociationRequest withTargets(Target... targets)

The targets (either instances or tags) for the association. Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

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

Parameters:

targets - The targets (either instances or tags) for the association. Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

Returns:

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

withTargets

public CreateAssociationRequest withTargets(Collection<Target> targets)

The targets (either instances or tags) for the association. Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

Parameters:

targets - The targets (either instances or tags) for the association. Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

Returns:

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

setScheduleExpression

public void setScheduleExpression(String scheduleExpression)

A cron expression when the association will be applied to the target(s). Supported expressions are every half, 1, 2, 4, 8 or 12 hour(s); every specified day and time of the week. For example: cron(0 0/30 * 1/1 * ? *) to run every thirty minutes; cron(0 0 0/4 1/1 * ? *) to run every four hours; and cron(0 0 10 ? * SUN *) to run every Sunday at 10 a.m.

Parameters:

scheduleExpression - A cron expression when the association will be applied to the target(s). Supported expressions are every half, 1, 2, 4, 8 or 12 hour(s); every specified day and time of the week. For example: cron(0 0/30 * 1/1 * ? *) to run every thirty minutes; cron(0 0 0/4 1/1 * ? *) to run every four hours; and cron(0 0 10 ? * SUN *) to run every Sunday at 10 a.m.

getScheduleExpression

public String getScheduleExpression()

A cron expression when the association will be applied to the target(s). Supported expressions are every half, 1, 2, 4, 8 or 12 hour(s); every specified day and time of the week. For example: cron(0 0/30 * 1/1 * ? *) to run every thirty minutes; cron(0 0 0/4 1/1 * ? *) to run every four hours; and cron(0 0 10 ? * SUN *) to run every Sunday at 10 a.m.

Returns:

A cron expression when the association will be applied to the target(s). Supported expressions are every half, 1, 2, 4, 8 or 12 hour(s); every specified day and time of the week. For example: cron(0 0/30 * 1/1 * ? *) to run every thirty minutes; cron(0 0 0/4 1/1 * ? *) to run every four hours; and cron(0 0 10 ? * SUN *) to run every Sunday at 10 a.m.

withScheduleExpression

public CreateAssociationRequest withScheduleExpression(String scheduleExpression)

A cron expression when the association will be applied to the target(s). Supported expressions are every half, 1, 2, 4, 8 or 12 hour(s); every specified day and time of the week. For example: cron(0 0/30 * 1/1 * ? *) to run every thirty minutes; cron(0 0 0/4 1/1 * ? *) to run every four hours; and cron(0 0 10 ? * SUN *) to run every Sunday at 10 a.m.

Parameters:

scheduleExpression - A cron expression when the association will be applied to the target(s). Supported expressions are every half, 1, 2, 4, 8 or 12 hour(s); every specified day and time of the week. For example: cron(0 0/30 * 1/1 * ? *) to run every thirty minutes; cron(0 0 0/4 1/1 * ? *) to run every four hours; and cron(0 0 10 ? * SUN *) to run every Sunday at 10 a.m.

Returns:

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

setOutputLocation

public void setOutputLocation(InstanceAssociationOutputLocation outputLocation)

An Amazon S3 bucket where you want to store the output details of the request. For example:

"{ \"S3Location\": { \"OutputS3Region\": \"<region>\", \"OutputS3BucketName\": \"bucket name\", \"OutputS3KeyPrefix\": \"folder name\" } }"

Parameters:

outputLocation - An Amazon S3 bucket where you want to store the output details of the request. For example:

"{ \"S3Location\": { \"OutputS3Region\": \"<region>\", \"OutputS3BucketName\": \"bucket name\", \"OutputS3KeyPrefix\": \"folder name\" } }"

getOutputLocation

public InstanceAssociationOutputLocation getOutputLocation()

An Amazon S3 bucket where you want to store the output details of the request. For example:

"{ \"S3Location\": { \"OutputS3Region\": \"<region>\", \"OutputS3BucketName\": \"bucket name\", \"OutputS3KeyPrefix\": \"folder name\" } }"

Returns:

An Amazon S3 bucket where you want to store the output details of the request. For example:

"{ \"S3Location\": { \"OutputS3Region\": \"<region>\", \"OutputS3BucketName\": \"bucket name\", \"OutputS3KeyPrefix\": \"folder name\" } }"

withOutputLocation

public CreateAssociationRequest withOutputLocation(InstanceAssociationOutputLocation outputLocation)

An Amazon S3 bucket where you want to store the output details of the request. For example:

"{ \"S3Location\": { \"OutputS3Region\": \"<region>\", \"OutputS3BucketName\": \"bucket name\", \"OutputS3KeyPrefix\": \"folder name\" } }"

Parameters:

outputLocation - An Amazon S3 bucket where you want to store the output details of the request. For example:

"{ \"S3Location\": { \"OutputS3Region\": \"<region>\", \"OutputS3BucketName\": \"bucket name\", \"OutputS3KeyPrefix\": \"folder name\" } }"

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; useful for testing and debugging.

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 CreateAssociationRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()