com.amazonaws.services.simplesystemsmanagement.model

Class CreateAssociationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simplesystemsmanagement.model.CreateAssociationRequest

All Implemented Interfaces:

HandlerContextAware, 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 object for all fields except the handler context.
boolean	equals(Object obj)
String	getAssociationName() Specify a descriptive name for the association.
String	getComplianceSeverity() The severity level to assign to the association.
String	getDocumentVersion() The document version you want to associate with the target(s).
String	getInstanceId() The instance ID.
String	getMaxConcurrency() The maximum number of targets allowed to run the association at the same time.
String	getMaxErrors() The number of errors that are allowed before the system stops sending requests to run the association on additional targets.
String	getName() The name of the Systems Manager 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	setAssociationName(String associationName) Specify a descriptive name for the association.
void	setComplianceSeverity(String complianceSeverity) The severity level to assign to the association.
void	setDocumentVersion(String documentVersion) The document version you want to associate with the target(s).
void	setInstanceId(String instanceId) The instance ID.
void	setMaxConcurrency(String maxConcurrency) The maximum number of targets allowed to run the association at the same time.
void	setMaxErrors(String maxErrors) The number of errors that are allowed before the system stops sending requests to run the association on additional targets.
void	setName(String name) The name of the Systems Manager 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	withAssociationName(String associationName) Specify a descriptive name for the association.
CreateAssociationRequest	withComplianceSeverity(AssociationComplianceSeverity complianceSeverity) The severity level to assign to the association.
CreateAssociationRequest	withComplianceSeverity(String complianceSeverity) The severity level to assign to the association.
CreateAssociationRequest	withDocumentVersion(String documentVersion) The document version you want to associate with the target(s).
CreateAssociationRequest	withInstanceId(String instanceId) The instance ID.
CreateAssociationRequest	withMaxConcurrency(String maxConcurrency) The maximum number of targets allowed to run the association at the same time.
CreateAssociationRequest	withMaxErrors(String maxErrors) The number of errors that are allowed before the system stops sending requests to run the association on additional targets.
CreateAssociationRequest	withName(String name) The name of the Systems Manager 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

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, 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 Systems Manager document.

Parameters:

name - The name of the Systems Manager document.

getName

public String getName()

The name of the Systems Manager document.

Returns:

The name of the Systems Manager document.

withName

public CreateAssociationRequest withName(String name)

The name of the Systems Manager document.

Parameters:

name - The name of the Systems Manager 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.

Returns:

The targets (either instances or tags) for the association.

setTargets

public void setTargets(Collection<Target> targets)

The targets (either instances or tags) for the association.

Parameters:

targets - The targets (either instances or tags) for the association.

withTargets

public CreateAssociationRequest withTargets(Target... targets)

The targets (either instances or tags) for the association.

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.

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.

Parameters:

targets - The targets (either instances or tags) for the association.

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).

Parameters:

scheduleExpression - A cron expression when the association will be applied to the target(s).

getScheduleExpression

public String getScheduleExpression()

A cron expression when the association will be applied to the target(s).

Returns:

A cron expression when the association will be applied to the target(s).

withScheduleExpression

public CreateAssociationRequest withScheduleExpression(String scheduleExpression)

A cron expression when the association will be applied to the target(s).

Parameters:

scheduleExpression - A cron expression when the association will be applied to the target(s).

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.

Parameters:

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

getOutputLocation

public InstanceAssociationOutputLocation getOutputLocation()

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

Returns:

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

withOutputLocation

public CreateAssociationRequest withOutputLocation(InstanceAssociationOutputLocation outputLocation)

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

Parameters:

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

Returns:

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

setAssociationName

public void setAssociationName(String associationName)

Specify a descriptive name for the association.

Parameters:

associationName - Specify a descriptive name for the association.

getAssociationName

public String getAssociationName()

Specify a descriptive name for the association.

Returns:

Specify a descriptive name for the association.

withAssociationName

public CreateAssociationRequest withAssociationName(String associationName)

Specify a descriptive name for the association.

Parameters:

associationName - Specify a descriptive name for the association.

Returns:

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

setMaxErrors

public void setMaxErrors(String maxErrors)

The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

Parameters:

maxErrors - The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

getMaxErrors

public String getMaxErrors()

The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

Returns:

The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

withMaxErrors

public CreateAssociationRequest withMaxErrors(String maxErrors)

The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

Parameters:

maxErrors - The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

Returns:

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

setMaxConcurrency

public void setMaxConcurrency(String maxConcurrency)

The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

If a new instance starts and attempts to execute an association while Systems Manager is executing MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

Parameters:

maxConcurrency - The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

If a new instance starts and attempts to execute an association while Systems Manager is executing MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

getMaxConcurrency

public String getMaxConcurrency()

The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

If a new instance starts and attempts to execute an association while Systems Manager is executing MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

Returns:

The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

If a new instance starts and attempts to execute an association while Systems Manager is executing MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

withMaxConcurrency

public CreateAssociationRequest withMaxConcurrency(String maxConcurrency)

The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

If a new instance starts and attempts to execute an association while Systems Manager is executing MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

Parameters:

maxConcurrency - The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

If a new instance starts and attempts to execute an association while Systems Manager is executing MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

Returns:

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

setComplianceSeverity

public void setComplianceSeverity(String complianceSeverity)

The severity level to assign to the association.

Parameters:

complianceSeverity - The severity level to assign to the association.

See Also:

AssociationComplianceSeverity

getComplianceSeverity

public String getComplianceSeverity()

The severity level to assign to the association.

Returns:

The severity level to assign to the association.

See Also:

AssociationComplianceSeverity

withComplianceSeverity

public CreateAssociationRequest withComplianceSeverity(String complianceSeverity)

The severity level to assign to the association.

Parameters:

complianceSeverity - The severity level to assign to the association.

Returns:

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

See Also:

AssociationComplianceSeverity

withComplianceSeverity

public CreateAssociationRequest withComplianceSeverity(AssociationComplianceSeverity complianceSeverity)

The severity level to assign to the association.

Parameters:

complianceSeverity - The severity level to assign to the association.

Returns:

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

See Also:

AssociationComplianceSeverity

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 object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()