@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)
Add a single Parameters entry
|
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) |
AlarmConfiguration |
getAlarmConfiguration() |
Boolean |
getApplyOnlyAtCronInterval()
By default, when you update an association, the system runs it immediately after it is updated and then according
to the schedule you specified.
|
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()
Choose the parameter that will define how your automation will branch out.
|
List<String> |
getCalendarNames()
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your
associations under.
|
String |
getComplianceSeverity()
The severity level to assign to the association.
|
String |
getDocumentVersion()
The document version you want update for the association.
|
Integer |
getDuration()
The number of hours the association can run before it is canceled.
|
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 Command document or Automation runbook that contains the configuration information for the
managed node.
|
InstanceAssociationOutputLocation |
getOutputLocation()
An 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.
|
Integer |
getScheduleOffset()
Number of days to wait after the scheduled day to run an association.
|
String |
getSyncCompliance()
The mode for generating association compliance.
|
List<TargetLocation> |
getTargetLocations()
A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run
the association.
|
List<Map<String,List<String>>> |
getTargetMaps()
A key-value mapping of document parameters to target resources.
|
List<Target> |
getTargets()
The targets of the association.
|
int |
hashCode() |
Boolean |
isApplyOnlyAtCronInterval()
By default, when you update an association, the system runs it immediately after it is updated and then according
to the schedule you specified.
|
void |
setAlarmConfiguration(AlarmConfiguration alarmConfiguration) |
void |
setApplyOnlyAtCronInterval(Boolean applyOnlyAtCronInterval)
By default, when you update an association, the system runs it immediately after it is updated and then according
to the schedule you specified.
|
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)
Choose the parameter that will define how your automation will branch out.
|
void |
setCalendarNames(Collection<String> calendarNames)
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your
associations under.
|
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 |
setDuration(Integer duration)
The number of hours the association can run before it is canceled.
|
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 Command document or Automation runbook that contains the configuration information for the
managed node.
|
void |
setOutputLocation(InstanceAssociationOutputLocation outputLocation)
An 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 |
setScheduleOffset(Integer scheduleOffset)
Number of days to wait after the scheduled day to run an association.
|
void |
setSyncCompliance(String syncCompliance)
The mode for generating association compliance.
|
void |
setTargetLocations(Collection<TargetLocation> targetLocations)
A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run
the association.
|
void |
setTargetMaps(Collection<Map<String,List<String>>> targetMaps)
A key-value mapping of document parameters to target resources.
|
void |
setTargets(Collection<Target> targets)
The targets of the association.
|
String |
toString()
Returns a string representation of this object.
|
UpdateAssociationRequest |
withAlarmConfiguration(AlarmConfiguration alarmConfiguration) |
UpdateAssociationRequest |
withApplyOnlyAtCronInterval(Boolean applyOnlyAtCronInterval)
By default, when you update an association, the system runs it immediately after it is updated and then according
to the schedule you specified.
|
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)
Choose the parameter that will define how your automation will branch out.
|
UpdateAssociationRequest |
withCalendarNames(Collection<String> calendarNames)
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your
associations under.
|
UpdateAssociationRequest |
withCalendarNames(String... calendarNames)
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your
associations under.
|
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 |
withDuration(Integer duration)
The number of hours the association can run before it is canceled.
|
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 Command document or Automation runbook that contains the configuration information for the
managed node.
|
UpdateAssociationRequest |
withOutputLocation(InstanceAssociationOutputLocation outputLocation)
An 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 |
withScheduleOffset(Integer scheduleOffset)
Number of days to wait after the scheduled day to run an association.
|
UpdateAssociationRequest |
withSyncCompliance(AssociationSyncCompliance syncCompliance)
The mode for generating association compliance.
|
UpdateAssociationRequest |
withSyncCompliance(String syncCompliance)
The mode for generating association compliance.
|
UpdateAssociationRequest |
withTargetLocations(Collection<TargetLocation> targetLocations)
A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run
the association.
|
UpdateAssociationRequest |
withTargetLocations(TargetLocation... targetLocations)
A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run
the association.
|
UpdateAssociationRequest |
withTargetMaps(Collection<Map<String,List<String>>> targetMaps)
A key-value mapping of document parameters to target resources.
|
UpdateAssociationRequest |
withTargetMaps(Map<String,List<String>>... targetMaps)
A key-value mapping of document parameters to target resources.
|
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, a
capability of Amazon Web Services Systems Manager, you can reference the parameter using
{{ssm:parameter-name}}
.
{{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, a
capability of Amazon Web Services Systems Manager, 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, a
capability of Amazon Web Services Systems Manager, 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, a
capability of Amazon Web Services Systems Manager, 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, a
capability of Amazon Web Services Systems Manager, 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.
State Manager doesn't support running associations that use a new version of a document if that document is
shared from another account. State Manager always runs the default
version of a document if shared
from another account, even though the Systems Manager console shows that a new version was processed. If you want
to run an association using a new version of a document shared form another account, you must set the document
version to default
.
documentVersion
- The document version you want update for the association.
State Manager doesn't support running associations that use a new version of a document if that document
is shared from another account. State Manager always runs the default
version of a document
if shared from another account, even though the Systems Manager console shows that a new version was
processed. If you want to run an association using a new version of a document shared form another
account, you must set the document version to default
.
public String getDocumentVersion()
The document version you want update for the association.
State Manager doesn't support running associations that use a new version of a document if that document is
shared from another account. State Manager always runs the default
version of a document if shared
from another account, even though the Systems Manager console shows that a new version was processed. If you want
to run an association using a new version of a document shared form another account, you must set the document
version to default
.
State Manager doesn't support running associations that use a new version of a document if that document
is shared from another account. State Manager always runs the default
version of a document
if shared from another account, even though the Systems Manager console shows that a new version was
processed. If you want to run an association using a new version of a document shared form another
account, you must set the document version to default
.
public UpdateAssociationRequest withDocumentVersion(String documentVersion)
The document version you want update for the association.
State Manager doesn't support running associations that use a new version of a document if that document is
shared from another account. State Manager always runs the default
version of a document if shared
from another account, even though the Systems Manager console shows that a new version was processed. If you want
to run an association using a new version of a document shared form another account, you must set the document
version to default
.
documentVersion
- The document version you want update for the association.
State Manager doesn't support running associations that use a new version of a document if that document
is shared from another account. State Manager always runs the default
version of a document
if shared from another account, even though the Systems Manager console shows that a new version was
processed. If you want to run an association using a new version of a document shared form another
account, you must set the document version to default
.
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 S3 bucket where you want to store the results of this request.
outputLocation
- An S3 bucket where you want to store the results of this request.public InstanceAssociationOutputLocation getOutputLocation()
An S3 bucket where you want to store the results of this request.
public UpdateAssociationRequest withOutputLocation(InstanceAssociationOutputLocation outputLocation)
An S3 bucket where you want to store the results of this request.
outputLocation
- An S3 bucket where you want to store the results of this request.public void setName(String name)
The name of the SSM Command document or Automation runbook that contains the configuration information for the managed node.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For Systems Manager document (SSM document) that are shared with you from other Amazon Web Services 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 Amazon Web Services-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 Command document or Automation runbook that contains the configuration information for
the managed node.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For Systems Manager document (SSM document) that are shared with you from other Amazon Web Services 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 Amazon Web Services-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 Command document or Automation runbook that contains the configuration information for the managed node.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For Systems Manager document (SSM document) that are shared with you from other Amazon Web Services 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 Amazon Web Services-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 Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For Systems Manager document (SSM document) that are shared with you from other Amazon Web Services 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 Amazon Web Services-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 Command document or Automation runbook that contains the configuration information for the managed node.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For Systems Manager document (SSM document) that are shared with you from other Amazon Web Services 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 Amazon Web Services-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 Command document or Automation runbook that contains the configuration information for
the managed node.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For Systems Manager document (SSM document) that are shared with you from other Amazon Web Services 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 Amazon Web Services-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)
Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
automationTargetParameterName
- Choose the parameter that will define how your automation will branch out. This target is required for
associations that use an Automation runbook and target resources by using rate controls. Automation is a
capability of Amazon Web Services Systems Manager.public String getAutomationTargetParameterName()
Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
public UpdateAssociationRequest withAutomationTargetParameterName(String automationTargetParameterName)
Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
automationTargetParameterName
- Choose the parameter that will define how your automation will branch out. This target is required for
associations that use an Automation runbook and target resources by using rate controls. Automation is a
capability of Amazon Web Services Systems Manager.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 managed nodes 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 managed nodes 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 managed nodes 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.
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 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 managed nodes 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 managed nodes 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 managed node 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 managed node 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 managed node 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 managed node 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 managed node 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 managed node will process its association within the limit specified for
MaxConcurrency
.
If a new managed node 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 managed node 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 managed node 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 managed node 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 managed node 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 managed node 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 void setSyncCompliance(String syncCompliance)
The mode for generating association compliance. You can specify AUTO
or MANUAL
. In
AUTO
mode, the system uses the status of the association execution to determine the compliance
status. If the association execution runs successfully, then the association is COMPLIANT
. If the
association execution doesn't run successfully, the association is NON-COMPLIANT
.
In MANUAL
mode, you must specify the AssociationId
as a parameter for the
PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a
capability of Amazon Web Services Systems Manager. It is managed by your direct call to the
PutComplianceItems API operation.
By default, all associations use AUTO
mode.
syncCompliance
- The mode for generating association compliance. You can specify AUTO
or MANUAL
.
In AUTO
mode, the system uses the status of the association execution to determine the
compliance status. If the association execution runs successfully, then the association is
COMPLIANT
. If the association execution doesn't run successfully, the association is
NON-COMPLIANT
.
In MANUAL
mode, you must specify the AssociationId
as a parameter for the
PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a
capability of Amazon Web Services Systems Manager. It is managed by your direct call to the
PutComplianceItems API operation.
By default, all associations use AUTO
mode.
AssociationSyncCompliance
public String getSyncCompliance()
The mode for generating association compliance. You can specify AUTO
or MANUAL
. In
AUTO
mode, the system uses the status of the association execution to determine the compliance
status. If the association execution runs successfully, then the association is COMPLIANT
. If the
association execution doesn't run successfully, the association is NON-COMPLIANT
.
In MANUAL
mode, you must specify the AssociationId
as a parameter for the
PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a
capability of Amazon Web Services Systems Manager. It is managed by your direct call to the
PutComplianceItems API operation.
By default, all associations use AUTO
mode.
AUTO
or MANUAL
.
In AUTO
mode, the system uses the status of the association execution to determine the
compliance status. If the association execution runs successfully, then the association is
COMPLIANT
. If the association execution doesn't run successfully, the association is
NON-COMPLIANT
.
In MANUAL
mode, you must specify the AssociationId
as a parameter for the
PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a
capability of Amazon Web Services Systems Manager. It is managed by your direct call to the
PutComplianceItems API operation.
By default, all associations use AUTO
mode.
AssociationSyncCompliance
public UpdateAssociationRequest withSyncCompliance(String syncCompliance)
The mode for generating association compliance. You can specify AUTO
or MANUAL
. In
AUTO
mode, the system uses the status of the association execution to determine the compliance
status. If the association execution runs successfully, then the association is COMPLIANT
. If the
association execution doesn't run successfully, the association is NON-COMPLIANT
.
In MANUAL
mode, you must specify the AssociationId
as a parameter for the
PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a
capability of Amazon Web Services Systems Manager. It is managed by your direct call to the
PutComplianceItems API operation.
By default, all associations use AUTO
mode.
syncCompliance
- The mode for generating association compliance. You can specify AUTO
or MANUAL
.
In AUTO
mode, the system uses the status of the association execution to determine the
compliance status. If the association execution runs successfully, then the association is
COMPLIANT
. If the association execution doesn't run successfully, the association is
NON-COMPLIANT
.
In MANUAL
mode, you must specify the AssociationId
as a parameter for the
PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a
capability of Amazon Web Services Systems Manager. It is managed by your direct call to the
PutComplianceItems API operation.
By default, all associations use AUTO
mode.
AssociationSyncCompliance
public UpdateAssociationRequest withSyncCompliance(AssociationSyncCompliance syncCompliance)
The mode for generating association compliance. You can specify AUTO
or MANUAL
. In
AUTO
mode, the system uses the status of the association execution to determine the compliance
status. If the association execution runs successfully, then the association is COMPLIANT
. If the
association execution doesn't run successfully, the association is NON-COMPLIANT
.
In MANUAL
mode, you must specify the AssociationId
as a parameter for the
PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a
capability of Amazon Web Services Systems Manager. It is managed by your direct call to the
PutComplianceItems API operation.
By default, all associations use AUTO
mode.
syncCompliance
- The mode for generating association compliance. You can specify AUTO
or MANUAL
.
In AUTO
mode, the system uses the status of the association execution to determine the
compliance status. If the association execution runs successfully, then the association is
COMPLIANT
. If the association execution doesn't run successfully, the association is
NON-COMPLIANT
.
In MANUAL
mode, you must specify the AssociationId
as a parameter for the
PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a
capability of Amazon Web Services Systems Manager. It is managed by your direct call to the
PutComplianceItems API operation.
By default, all associations use AUTO
mode.
AssociationSyncCompliance
public void setApplyOnlyAtCronInterval(Boolean applyOnlyAtCronInterval)
By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter isn't supported for rate expressions.
If you chose this option when you created an association and later you edit that association or you make changes
to the SSM document on which that association is based (by using the Documents page in the console), State
Manager applies the association at the next specified cron interval. For example, if you chose the
Latest
version of an SSM document when you created an association and you edit the association by
choosing a different document version on the Documents page, State Manager applies the association at the next
specified cron interval if you previously selected this option. If this option wasn't selected, State Manager
immediately runs the association.
You can reset this option. To do so, specify the no-apply-only-at-cron-interval
parameter when you
update the association from the command line. This parameter forces the association to run immediately after
updating it and according to the interval specified.
applyOnlyAtCronInterval
- By default, when you update an association, the system runs it immediately after it is updated and then
according to the schedule you specified. Specify this option if you don't want an association to run
immediately after you update it. This parameter isn't supported for rate expressions.
If you chose this option when you created an association and later you edit that association or you make
changes to the SSM document on which that association is based (by using the Documents page in the
console), State Manager applies the association at the next specified cron interval. For example, if you
chose the Latest
version of an SSM document when you created an association and you edit the
association by choosing a different document version on the Documents page, State Manager applies the
association at the next specified cron interval if you previously selected this option. If this option
wasn't selected, State Manager immediately runs the association.
You can reset this option. To do so, specify the no-apply-only-at-cron-interval
parameter
when you update the association from the command line. This parameter forces the association to run
immediately after updating it and according to the interval specified.
public Boolean getApplyOnlyAtCronInterval()
By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter isn't supported for rate expressions.
If you chose this option when you created an association and later you edit that association or you make changes
to the SSM document on which that association is based (by using the Documents page in the console), State
Manager applies the association at the next specified cron interval. For example, if you chose the
Latest
version of an SSM document when you created an association and you edit the association by
choosing a different document version on the Documents page, State Manager applies the association at the next
specified cron interval if you previously selected this option. If this option wasn't selected, State Manager
immediately runs the association.
You can reset this option. To do so, specify the no-apply-only-at-cron-interval
parameter when you
update the association from the command line. This parameter forces the association to run immediately after
updating it and according to the interval specified.
If you chose this option when you created an association and later you edit that association or you make
changes to the SSM document on which that association is based (by using the Documents page in the
console), State Manager applies the association at the next specified cron interval. For example, if you
chose the Latest
version of an SSM document when you created an association and you edit the
association by choosing a different document version on the Documents page, State Manager applies the
association at the next specified cron interval if you previously selected this option. If this option
wasn't selected, State Manager immediately runs the association.
You can reset this option. To do so, specify the no-apply-only-at-cron-interval
parameter
when you update the association from the command line. This parameter forces the association to run
immediately after updating it and according to the interval specified.
public UpdateAssociationRequest withApplyOnlyAtCronInterval(Boolean applyOnlyAtCronInterval)
By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter isn't supported for rate expressions.
If you chose this option when you created an association and later you edit that association or you make changes
to the SSM document on which that association is based (by using the Documents page in the console), State
Manager applies the association at the next specified cron interval. For example, if you chose the
Latest
version of an SSM document when you created an association and you edit the association by
choosing a different document version on the Documents page, State Manager applies the association at the next
specified cron interval if you previously selected this option. If this option wasn't selected, State Manager
immediately runs the association.
You can reset this option. To do so, specify the no-apply-only-at-cron-interval
parameter when you
update the association from the command line. This parameter forces the association to run immediately after
updating it and according to the interval specified.
applyOnlyAtCronInterval
- By default, when you update an association, the system runs it immediately after it is updated and then
according to the schedule you specified. Specify this option if you don't want an association to run
immediately after you update it. This parameter isn't supported for rate expressions.
If you chose this option when you created an association and later you edit that association or you make
changes to the SSM document on which that association is based (by using the Documents page in the
console), State Manager applies the association at the next specified cron interval. For example, if you
chose the Latest
version of an SSM document when you created an association and you edit the
association by choosing a different document version on the Documents page, State Manager applies the
association at the next specified cron interval if you previously selected this option. If this option
wasn't selected, State Manager immediately runs the association.
You can reset this option. To do so, specify the no-apply-only-at-cron-interval
parameter
when you update the association from the command line. This parameter forces the association to run
immediately after updating it and according to the interval specified.
public Boolean isApplyOnlyAtCronInterval()
By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter isn't supported for rate expressions.
If you chose this option when you created an association and later you edit that association or you make changes
to the SSM document on which that association is based (by using the Documents page in the console), State
Manager applies the association at the next specified cron interval. For example, if you chose the
Latest
version of an SSM document when you created an association and you edit the association by
choosing a different document version on the Documents page, State Manager applies the association at the next
specified cron interval if you previously selected this option. If this option wasn't selected, State Manager
immediately runs the association.
You can reset this option. To do so, specify the no-apply-only-at-cron-interval
parameter when you
update the association from the command line. This parameter forces the association to run immediately after
updating it and according to the interval specified.
If you chose this option when you created an association and later you edit that association or you make
changes to the SSM document on which that association is based (by using the Documents page in the
console), State Manager applies the association at the next specified cron interval. For example, if you
chose the Latest
version of an SSM document when you created an association and you edit the
association by choosing a different document version on the Documents page, State Manager applies the
association at the next specified cron interval if you previously selected this option. If this option
wasn't selected, State Manager immediately runs the association.
You can reset this option. To do so, specify the no-apply-only-at-cron-interval
parameter
when you update the association from the command line. This parameter forces the association to run
immediately after updating it and according to the interval specified.
public List<String> getCalendarNames()
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
public void setCalendarNames(Collection<String> calendarNames)
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
calendarNames
- The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your
associations under. The associations only run when that change calendar is open. For more information, see
Amazon Web Services Systems Manager Change Calendar.public UpdateAssociationRequest withCalendarNames(String... calendarNames)
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
NOTE: This method appends the values to the existing list (if any). Use
setCalendarNames(java.util.Collection)
or withCalendarNames(java.util.Collection)
if you want
to override the existing values.
calendarNames
- The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your
associations under. The associations only run when that change calendar is open. For more information, see
Amazon Web Services Systems Manager Change Calendar.public UpdateAssociationRequest withCalendarNames(Collection<String> calendarNames)
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
calendarNames
- The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your
associations under. The associations only run when that change calendar is open. For more information, see
Amazon Web Services Systems Manager Change Calendar.public List<TargetLocation> getTargetLocations()
A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts.
public void setTargetLocations(Collection<TargetLocation> targetLocations)
A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts.
targetLocations
- A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want
to run the association. Use this action to update an association in multiple Regions and multiple
accounts.public UpdateAssociationRequest withTargetLocations(TargetLocation... targetLocations)
A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts.
NOTE: This method appends the values to the existing list (if any). Use
setTargetLocations(java.util.Collection)
or withTargetLocations(java.util.Collection)
if you
want to override the existing values.
targetLocations
- A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want
to run the association. Use this action to update an association in multiple Regions and multiple
accounts.public UpdateAssociationRequest withTargetLocations(Collection<TargetLocation> targetLocations)
A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts.
targetLocations
- A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want
to run the association. Use this action to update an association in multiple Regions and multiple
accounts.public void setScheduleOffset(Integer scheduleOffset)
Number of days to wait after the scheduled day to run an association. For example, if you specified a cron
schedule of cron(0 0 ? * THU#2 *)
, you could specify an offset of 3 to run the association each
Sunday after the second Thursday of the month. For more information about cron schedules for associations, see
Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User
Guide.
To use offsets, you must specify the ApplyOnlyAtCronInterval
parameter. This option tells the system
not to run an association immediately after you create it.
scheduleOffset
- Number of days to wait after the scheduled day to run an association. For example, if you specified a cron
schedule of cron(0 0 ? * THU#2 *)
, you could specify an offset of 3 to run the association
each Sunday after the second Thursday of the month. For more information about cron schedules for
associations, see Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems
Manager User Guide.
To use offsets, you must specify the ApplyOnlyAtCronInterval
parameter. This option tells the
system not to run an association immediately after you create it.
public Integer getScheduleOffset()
Number of days to wait after the scheduled day to run an association. For example, if you specified a cron
schedule of cron(0 0 ? * THU#2 *)
, you could specify an offset of 3 to run the association each
Sunday after the second Thursday of the month. For more information about cron schedules for associations, see
Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User
Guide.
To use offsets, you must specify the ApplyOnlyAtCronInterval
parameter. This option tells the system
not to run an association immediately after you create it.
cron(0 0 ? * THU#2 *)
, you could specify an offset of 3 to run the
association each Sunday after the second Thursday of the month. For more information about cron schedules
for associations, see Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems
Manager User Guide.
To use offsets, you must specify the ApplyOnlyAtCronInterval
parameter. This option tells
the system not to run an association immediately after you create it.
public UpdateAssociationRequest withScheduleOffset(Integer scheduleOffset)
Number of days to wait after the scheduled day to run an association. For example, if you specified a cron
schedule of cron(0 0 ? * THU#2 *)
, you could specify an offset of 3 to run the association each
Sunday after the second Thursday of the month. For more information about cron schedules for associations, see
Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User
Guide.
To use offsets, you must specify the ApplyOnlyAtCronInterval
parameter. This option tells the system
not to run an association immediately after you create it.
scheduleOffset
- Number of days to wait after the scheduled day to run an association. For example, if you specified a cron
schedule of cron(0 0 ? * THU#2 *)
, you could specify an offset of 3 to run the association
each Sunday after the second Thursday of the month. For more information about cron schedules for
associations, see Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems
Manager User Guide.
To use offsets, you must specify the ApplyOnlyAtCronInterval
parameter. This option tells the
system not to run an association immediately after you create it.
public void setDuration(Integer duration)
The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.
The Duration
parameter applies only when both these conditions are true:
The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.
The command specifies the
ApplyOnlyAtCronInterval
parameter, which means that the association doesn't run immediately after it is updated, but only according to
the specified schedule.
duration
- The number of hours the association can run before it is canceled. Duration applies to associations that
are currently running, and any pending and in progress commands on all targets. If a target was taken
offline for the association to run, it is made available again immediately, without a reboot.
The Duration
parameter applies only when both these conditions are true:
The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.
The command specifies the
ApplyOnlyAtCronInterval
parameter, which means that the association doesn't run immediately after it is updated, but only
according to the specified schedule.
public Integer getDuration()
The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.
The Duration
parameter applies only when both these conditions are true:
The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.
The command specifies the
ApplyOnlyAtCronInterval
parameter, which means that the association doesn't run immediately after it is updated, but only according to
the specified schedule.
The Duration
parameter applies only when both these conditions are true:
The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.
The command specifies the
ApplyOnlyAtCronInterval
parameter, which means that the association doesn't run immediately after it is updated, but only
according to the specified schedule.
public UpdateAssociationRequest withDuration(Integer duration)
The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.
The Duration
parameter applies only when both these conditions are true:
The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.
The command specifies the
ApplyOnlyAtCronInterval
parameter, which means that the association doesn't run immediately after it is updated, but only according to
the specified schedule.
duration
- The number of hours the association can run before it is canceled. Duration applies to associations that
are currently running, and any pending and in progress commands on all targets. If a target was taken
offline for the association to run, it is made available again immediately, without a reboot.
The Duration
parameter applies only when both these conditions are true:
The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.
The command specifies the
ApplyOnlyAtCronInterval
parameter, which means that the association doesn't run immediately after it is updated, but only
according to the specified schedule.
public List<Map<String,List<String>>> getTargetMaps()
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
public void setTargetMaps(Collection<Map<String,List<String>>> targetMaps)
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
targetMaps
- A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be
specified together.public UpdateAssociationRequest withTargetMaps(Map<String,List<String>>... targetMaps)
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
NOTE: This method appends the values to the existing list (if any). Use
setTargetMaps(java.util.Collection)
or withTargetMaps(java.util.Collection)
if you want to
override the existing values.
targetMaps
- A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be
specified together.public UpdateAssociationRequest withTargetMaps(Collection<Map<String,List<String>>> targetMaps)
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
targetMaps
- A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be
specified together.public void setAlarmConfiguration(AlarmConfiguration alarmConfiguration)
alarmConfiguration
- public AlarmConfiguration getAlarmConfiguration()
public UpdateAssociationRequest withAlarmConfiguration(AlarmConfiguration alarmConfiguration)
alarmConfiguration
- public String toString()
toString
in class Object
Object.toString()
public UpdateAssociationRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()