/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.simplesystemsmanagement.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class UpdateAssociationRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The ID of the association you want to update. *
*/ private String associationId; /** *
* 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}}
.
*
* 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
.
*
* The cron expression used to schedule the association that you want to update. *
*/ private String scheduleExpression; /** ** An S3 bucket where you want to store the results of this request. *
*/ private InstanceAssociationOutputLocation outputLocation; /** ** 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
.
*
* The targets of the association. *
*/ private com.amazonaws.internal.SdkInternalList* The name of the association that you want to update. *
*/ private String associationName; /** *
* 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.
*
* 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. *
*/ private String automationTargetParameterName; /** *
* 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.
*
* 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
.
*
* The severity level to assign to the association. *
*/ private String complianceSeverity; /** *
* 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.
*
* 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.
*
* 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. *
*/ private com.amazonaws.internal.SdkInternalList* 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. *
*/ private com.amazonaws.internal.SdkInternalList
* 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.
*
* A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified * together. *
*/ private com.amazonaws.internal.SdkInternalList* The ID of the association you want to update. *
* * @param associationId * The ID of the association you want to update. */ public void setAssociationId(String associationId) { this.associationId = associationId; } /** ** The ID of the association you want to update. *
* * @return The ID of the association you want to update. */ public String getAssociationId() { return this.associationId; } /** ** The ID of the association you want to update. *
* * @param associationId * The ID of the association you want to update. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateAssociationRequest withAssociationId(String associationId) { setAssociationId(associationId); return this; } /** *
* 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 java.util.Map
* 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(java.util.Map
* 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}}
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateAssociationRequest withParameters(java.util.Map* 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
.
*
* 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
.
*
* 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
.
*
* The cron expression used to schedule the association that you want to update. *
* * @param scheduleExpression * The cron expression used to schedule the association that you want to update. */ public void setScheduleExpression(String scheduleExpression) { this.scheduleExpression = scheduleExpression; } /** ** The cron expression used to schedule the association that you want to update. *
* * @return The cron expression used to schedule the association that you want to update. */ public String getScheduleExpression() { return this.scheduleExpression; } /** ** The cron expression used to schedule the association that you want to update. *
* * @param scheduleExpression * The cron expression used to schedule the association that you want to update. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateAssociationRequest withScheduleExpression(String scheduleExpression) { setScheduleExpression(scheduleExpression); return this; } /** ** An S3 bucket where you want to store the results of this request. *
* * @param outputLocation * An S3 bucket where you want to store the results of this request. */ public void setOutputLocation(InstanceAssociationOutputLocation outputLocation) { this.outputLocation = outputLocation; } /** ** An S3 bucket where you want to store the results of this request. *
* * @return An S3 bucket where you want to store the results of this request. */ public InstanceAssociationOutputLocation getOutputLocation() { return this.outputLocation; } /** ** An S3 bucket where you want to store the results of this request. *
* * @param outputLocation * An S3 bucket where you want to store the results of this request. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateAssociationRequest withOutputLocation(InstanceAssociationOutputLocation outputLocation) { setOutputLocation(outputLocation); return this; } /** ** 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 void setName(String name) {
this.name = 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
.
*
* 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() {
return this.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
.
*
* 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
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateAssociationRequest withName(String name) {
setName(name);
return this;
}
/**
*
* The targets of the association. *
* * @return The targets of the association. */ public java.util.List* The targets of the association. *
* * @param targets * The targets of the association. */ public void setTargets(java.util.Collection* The targets of the association. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setTargets(java.util.Collection)} or {@link #withTargets(java.util.Collection)} if you want to override * the existing values. *
* * @param targets * The targets of the association. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateAssociationRequest withTargets(Target... targets) { if (this.targets == null) { setTargets(new com.amazonaws.internal.SdkInternalList* The targets of the association. *
* * @param targets * The targets of the association. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateAssociationRequest withTargets(java.util.Collection* The name of the association that you want to update. *
* * @param associationName * The name of the association that you want to update. */ public void setAssociationName(String associationName) { this.associationName = associationName; } /** ** The name of the association that you want to update. *
* * @return The name of the association that you want to update. */ public String getAssociationName() { return this.associationName; } /** ** The name of the association that you want to update. *
* * @param associationName * The name of the association that you want to update. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateAssociationRequest withAssociationName(String associationName) { setAssociationName(associationName); return this; } /** *
* 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 void setAssociationVersion(String associationVersion) {
this.associationVersion = 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.
*
$LATEST
, or omit this parameter.
*/
public String getAssociationVersion() {
return this.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.
*
$LATEST
, or omit this parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateAssociationRequest withAssociationVersion(String associationVersion) {
setAssociationVersion(associationVersion);
return this;
}
/**
* * 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. *
* * @param 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 setAutomationTargetParameterName(String automationTargetParameterName) { this.automationTargetParameterName = 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. *
* * @return 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() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateAssociationRequest withAutomationTargetParameterName(String automationTargetParameterName) { setAutomationTargetParameterName(automationTargetParameterName); return this; } /** *
* 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 void setMaxErrors(String maxErrors) {
this.maxErrors = 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.
*
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() {
return this.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.
*
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateAssociationRequest withMaxErrors(String maxErrors) {
setMaxErrors(maxErrors);
return this;
}
/**
*
* 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 void setMaxConcurrency(String maxConcurrency) {
this.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
.
*
* 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() {
return this.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
.
*
* 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
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateAssociationRequest withMaxConcurrency(String maxConcurrency) {
setMaxConcurrency(maxConcurrency);
return this;
}
/**
*
* The severity level to assign to the association. *
* * @param complianceSeverity * The severity level to assign to the association. * @see AssociationComplianceSeverity */ public void setComplianceSeverity(String complianceSeverity) { this.complianceSeverity = complianceSeverity; } /** ** The severity level to assign to the association. *
* * @return The severity level to assign to the association. * @see AssociationComplianceSeverity */ public String getComplianceSeverity() { return this.complianceSeverity; } /** ** The severity level to assign to the association. *
* * @param complianceSeverity * The severity level to assign to the association. * @return Returns a reference to this object so that method calls can be chained together. * @see AssociationComplianceSeverity */ public UpdateAssociationRequest withComplianceSeverity(String complianceSeverity) { setComplianceSeverity(complianceSeverity); return this; } /** ** The severity level to assign to the association. *
* * @param complianceSeverity * The severity level to assign to the association. * @return Returns a reference to this object so that method calls can be chained together. * @see AssociationComplianceSeverity */ public UpdateAssociationRequest withComplianceSeverity(AssociationComplianceSeverity complianceSeverity) { this.complianceSeverity = complianceSeverity.toString(); return this; } /** *
* 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.
* @see AssociationSyncCompliance
*/
public void setSyncCompliance(String syncCompliance) {
this.syncCompliance = 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.
*
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.
* @see AssociationSyncCompliance
*/
public String getSyncCompliance() {
return this.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.
*
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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AssociationSyncCompliance
*/
public UpdateAssociationRequest withSyncCompliance(String syncCompliance) {
setSyncCompliance(syncCompliance);
return this;
}
/**
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AssociationSyncCompliance
*/
public UpdateAssociationRequest withSyncCompliance(AssociationSyncCompliance syncCompliance) {
this.syncCompliance = syncCompliance.toString();
return this;
}
/**
*
* 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 void setApplyOnlyAtCronInterval(Boolean applyOnlyAtCronInterval) {
this.applyOnlyAtCronInterval = 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.
*
* 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() {
return this.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.
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateAssociationRequest withApplyOnlyAtCronInterval(Boolean applyOnlyAtCronInterval) {
setApplyOnlyAtCronInterval(applyOnlyAtCronInterval);
return this;
}
/**
*
* 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 Boolean isApplyOnlyAtCronInterval() {
return this.applyOnlyAtCronInterval;
}
/**
*
* 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. *
* * @return 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 java.util.List* 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. *
* * @param 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 void setCalendarNames(java.util.Collection* 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 * {@link #setCalendarNames(java.util.Collection)} or {@link #withCalendarNames(java.util.Collection)} if you want * to override the existing values. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateAssociationRequest withCalendarNames(String... calendarNames) { if (this.calendarNames == null) { setCalendarNames(new com.amazonaws.internal.SdkInternalList* 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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateAssociationRequest withCalendarNames(java.util.Collection* 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. *
* * @return 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 java.util.List* 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. *
* * @param 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 setTargetLocations(java.util.Collection* 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 * {@link #setTargetLocations(java.util.Collection)} or {@link #withTargetLocations(java.util.Collection)} if you * want to override the existing values. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateAssociationRequest withTargetLocations(TargetLocation... targetLocations) { if (this.targetLocations == null) { setTargetLocations(new com.amazonaws.internal.SdkInternalList* 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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateAssociationRequest withTargetLocations(java.util.Collection
* 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.
*
* 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.
*
* 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.
*
* A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified * together. *
* * @return A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be * specified together. */ public java.util.List* A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified * together. *
* * @param targetMaps * A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be * specified together. */ public void setTargetMaps(java.util.Collection* 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 * {@link #setTargetMaps(java.util.Collection)} or {@link #withTargetMaps(java.util.Collection)} if you want to * override the existing values. *
* * @param targetMaps * A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be * specified together. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateAssociationRequest withTargetMaps(java.util.Map* A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified * together. *
* * @param targetMaps * A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be * specified together. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateAssociationRequest withTargetMaps(java.util.Collection