@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UpdateAssociationRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
UpdateAssociationRequest() |
Modifier and Type | Method and Description |
---|---|
UpdateAssociationRequest |
addParametersEntry(String key,
List<String> value) |
UpdateAssociationRequest |
clearParametersEntries()
Removes all the entries added into Parameters.
|
UpdateAssociationRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getAssociationId()
The ID of the association you want to update.
|
String |
getAssociationName()
The name of the association that you want to update.
|
String |
getAssociationVersion()
This parameter is provided for concurrency control purposes.
|
String |
getAutomationTargetParameterName()
Specify the target for the association.
|
String |
getComplianceSeverity()
The severity level to assign to the association.
|
String |
getDocumentVersion()
The document version you want update for the association.
|
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 SSM document that contains the configuration information for the instance.
|
InstanceAssociationOutputLocation |
getOutputLocation()
An Amazon S3 bucket where you want to store the results of this request.
|
Map<String,List<String>> |
getParameters()
The parameters you want to update for the association.
|
String |
getScheduleExpression()
The cron expression used to schedule the association that you want to update.
|
List<Target> |
getTargets()
The targets of the association.
|
int |
hashCode() |
void |
setAssociationId(String associationId)
The ID of the association you want to update.
|
void |
setAssociationName(String associationName)
The name of the association that you want to update.
|
void |
setAssociationVersion(String associationVersion)
This parameter is provided for concurrency control purposes.
|
void |
setAutomationTargetParameterName(String automationTargetParameterName)
Specify the target for the association.
|
void |
setComplianceSeverity(String complianceSeverity)
The severity level to assign to the association.
|
void |
setDocumentVersion(String documentVersion)
The document version you want update for the association.
|
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 SSM document that contains the configuration information for the instance.
|
void |
setOutputLocation(InstanceAssociationOutputLocation outputLocation)
An Amazon S3 bucket where you want to store the results of this request.
|
void |
setParameters(Map<String,List<String>> parameters)
The parameters you want to update for the association.
|
void |
setScheduleExpression(String scheduleExpression)
The cron expression used to schedule the association that you want to update.
|
void |
setTargets(Collection<Target> targets)
The targets of the association.
|
String |
toString()
Returns a string representation of this object.
|
UpdateAssociationRequest |
withAssociationId(String associationId)
The ID of the association you want to update.
|
UpdateAssociationRequest |
withAssociationName(String associationName)
The name of the association that you want to update.
|
UpdateAssociationRequest |
withAssociationVersion(String associationVersion)
This parameter is provided for concurrency control purposes.
|
UpdateAssociationRequest |
withAutomationTargetParameterName(String automationTargetParameterName)
Specify the target for the association.
|
UpdateAssociationRequest |
withComplianceSeverity(AssociationComplianceSeverity complianceSeverity)
The severity level to assign to the association.
|
UpdateAssociationRequest |
withComplianceSeverity(String complianceSeverity)
The severity level to assign to the association.
|
UpdateAssociationRequest |
withDocumentVersion(String documentVersion)
The document version you want update for the association.
|
UpdateAssociationRequest |
withMaxConcurrency(String maxConcurrency)
The maximum number of targets allowed to run the association at the same time.
|
UpdateAssociationRequest |
withMaxErrors(String maxErrors)
The number of errors that are allowed before the system stops sending requests to run the association on
additional targets.
|
UpdateAssociationRequest |
withName(String name)
The name of the SSM document that contains the configuration information for the instance.
|
UpdateAssociationRequest |
withOutputLocation(InstanceAssociationOutputLocation outputLocation)
An Amazon S3 bucket where you want to store the results of this request.
|
UpdateAssociationRequest |
withParameters(Map<String,List<String>> parameters)
The parameters you want to update for the association.
|
UpdateAssociationRequest |
withScheduleExpression(String scheduleExpression)
The cron expression used to schedule the association that you want to update.
|
UpdateAssociationRequest |
withTargets(Collection<Target> targets)
The targets of the association.
|
UpdateAssociationRequest |
withTargets(Target... targets)
The targets of the association.
|
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
public void setAssociationId(String associationId)
The ID of the association you want to update.
associationId
- The ID of the association you want to update.public String getAssociationId()
The ID of the association you want to update.
public UpdateAssociationRequest withAssociationId(String associationId)
The ID of the association you want to update.
associationId
- The ID of the association you want to update.public Map<String,List<String>> getParameters()
The parameters you want to update for the association. If you create a parameter using Parameter Store, you can reference the parameter using {{ssm:parameter-name}}
public void setParameters(Map<String,List<String>> parameters)
The parameters you want to update for the association. If you create a parameter using Parameter Store, you can reference the parameter using {{ssm:parameter-name}}
parameters
- The parameters you want to update for the association. If you create a parameter using Parameter Store,
you can reference the parameter using {{ssm:parameter-name}}public UpdateAssociationRequest withParameters(Map<String,List<String>> parameters)
The parameters you want to update for the association. If you create a parameter using Parameter Store, you can reference the parameter using {{ssm:parameter-name}}
parameters
- The parameters you want to update for the association. If you create a parameter using Parameter Store,
you can reference the parameter using {{ssm:parameter-name}}public UpdateAssociationRequest addParametersEntry(String key, List<String> value)
public UpdateAssociationRequest clearParametersEntries()
public void setDocumentVersion(String documentVersion)
The document version you want update for the association.
documentVersion
- The document version you want update for the association.public String getDocumentVersion()
The document version you want update for the association.
public UpdateAssociationRequest withDocumentVersion(String documentVersion)
The document version you want update for the association.
documentVersion
- The document version you want update for the association.public void setScheduleExpression(String scheduleExpression)
The cron expression used to schedule the association that you want to update.
scheduleExpression
- The cron expression used to schedule the association that you want to update.public String getScheduleExpression()
The cron expression used to schedule the association that you want to update.
public UpdateAssociationRequest withScheduleExpression(String scheduleExpression)
The cron expression used to schedule the association that you want to update.
scheduleExpression
- The cron expression used to schedule the association that you want to update.public void setOutputLocation(InstanceAssociationOutputLocation outputLocation)
An Amazon S3 bucket where you want to store the results of this request.
outputLocation
- An Amazon S3 bucket where you want to store the results of this request.public InstanceAssociationOutputLocation getOutputLocation()
An Amazon S3 bucket where you want to store the results of this request.
public UpdateAssociationRequest withOutputLocation(InstanceAssociationOutputLocation outputLocation)
An Amazon S3 bucket where you want to store the results of this request.
outputLocation
- An Amazon S3 bucket where you want to store the results of this request.public void setName(String name)
The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.
You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.
For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document
name. For example, AWS-ApplyPatchBaseline
or My-Document
.
name
- The name of the SSM document that contains the configuration information for the instance. You can specify
Command or Automation documents.
You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.
For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For AWS-predefined documents and SSM documents you created in your account, you only need to specify the
document name. For example, AWS-ApplyPatchBaseline
or My-Document
.
public String getName()
The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.
You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.
For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document
name. For example, AWS-ApplyPatchBaseline
or My-Document
.
You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.
For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For AWS-predefined documents and SSM documents you created in your account, you only need to specify the
document name. For example, AWS-ApplyPatchBaseline
or My-Document
.
public UpdateAssociationRequest withName(String name)
The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.
You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.
For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document
name. For example, AWS-ApplyPatchBaseline
or My-Document
.
name
- The name of the SSM document that contains the configuration information for the instance. You can specify
Command or Automation documents.
You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.
For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For AWS-predefined documents and SSM documents you created in your account, you only need to specify the
document name. For example, AWS-ApplyPatchBaseline
or My-Document
.
public List<Target> getTargets()
The targets of the association.
public void setTargets(Collection<Target> targets)
The targets of the association.
targets
- The targets of the association.public UpdateAssociationRequest withTargets(Target... targets)
The targets of 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.
targets
- The targets of the association.public UpdateAssociationRequest withTargets(Collection<Target> targets)
The targets of the association.
targets
- The targets of the association.public void setAssociationName(String associationName)
The name of the association that you want to update.
associationName
- The name of the association that you want to update.public String getAssociationName()
The name of the association that you want to update.
public UpdateAssociationRequest withAssociationName(String associationName)
The name of the association that you want to update.
associationName
- The name of the association that you want to update.public void setAssociationVersion(String associationVersion)
This parameter is provided for concurrency control purposes. You must specify the latest association version in
the service. If you want to ensure that this request succeeds, either specify $LATEST
, or omit this
parameter.
associationVersion
- This parameter is provided for concurrency control purposes. You must specify the latest association
version in the service. If you want to ensure that this request succeeds, either specify
$LATEST
, or omit this parameter.public String getAssociationVersion()
This parameter is provided for concurrency control purposes. You must specify the latest association version in
the service. If you want to ensure that this request succeeds, either specify $LATEST
, or omit this
parameter.
$LATEST
, or omit this parameter.public UpdateAssociationRequest withAssociationVersion(String associationVersion)
This parameter is provided for concurrency control purposes. You must specify the latest association version in
the service. If you want to ensure that this request succeeds, either specify $LATEST
, or omit this
parameter.
associationVersion
- This parameter is provided for concurrency control purposes. You must specify the latest association
version in the service. If you want to ensure that this request succeeds, either specify
$LATEST
, or omit this parameter.public void setAutomationTargetParameterName(String automationTargetParameterName)
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
automationTargetParameterName
- Specify the target for the association. This target is required for associations that use an Automation
document and target resources by using rate controls.public String getAutomationTargetParameterName()
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
public UpdateAssociationRequest withAutomationTargetParameterName(String automationTargetParameterName)
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
automationTargetParameterName
- Specify the target for the association. This target is required for associations that use an Automation
document and target resources by using rate controls.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.
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.
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.
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.
public UpdateAssociationRequest 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.
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.
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 run an association while Systems Manager is running 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.
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 run an association while Systems Manager is running 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.
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 run an association while Systems Manager is running 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.
If a new instance starts and attempts to run an association while Systems Manager is running 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.
public UpdateAssociationRequest 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 run an association while Systems Manager is running 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.
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 run an association while Systems Manager is running 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.
public void setComplianceSeverity(String complianceSeverity)
The severity level to assign to the association.
complianceSeverity
- The severity level to assign to the association.AssociationComplianceSeverity
public String getComplianceSeverity()
The severity level to assign to the association.
AssociationComplianceSeverity
public UpdateAssociationRequest withComplianceSeverity(String complianceSeverity)
The severity level to assign to the association.
complianceSeverity
- The severity level to assign to the association.AssociationComplianceSeverity
public UpdateAssociationRequest withComplianceSeverity(AssociationComplianceSeverity complianceSeverity)
The severity level to assign to the association.
complianceSeverity
- The severity level to assign to the association.AssociationComplianceSeverity
public String toString()
toString
in class Object
Object.toString()
public UpdateAssociationRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.