@Generated(value="software.amazon.awssdk:codegen") public final class UpdateAssociationRequest extends SsmRequest implements ToCopyableBuilder<UpdateAssociationRequest.Builder,UpdateAssociationRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
UpdateAssociationRequest.Builder |
Modifier and Type | Method and Description |
---|---|
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.
|
String |
associationId()
The ID of the association you want to update.
|
String |
associationName()
The name of the association that you want to update.
|
String |
associationVersion()
This parameter is provided for concurrency control purposes.
|
String |
automationTargetParameterName()
Specify the target for the association.
|
static UpdateAssociationRequest.Builder |
builder() |
AssociationComplianceSeverity |
complianceSeverity()
The severity level to assign to the association.
|
String |
complianceSeverityAsString()
The severity level to assign to the association.
|
String |
documentVersion()
The document version you want update for the association.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
boolean |
hasParameters()
Returns true if the Parameters property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
boolean |
hasTargetLocations()
Returns true if the TargetLocations property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasTargets()
Returns true if the Targets property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
String |
maxConcurrency()
The maximum number of targets allowed to run the association at the same time.
|
String |
maxErrors()
The number of errors that are allowed before the system stops sending requests to run the association on
additional targets.
|
String |
name()
The name of the SSM document that contains the configuration information for the instance.
|
InstanceAssociationOutputLocation |
outputLocation()
An S3 bucket where you want to store the results of this request.
|
Map<String,List<String>> |
parameters()
The parameters you want to update for the association.
|
String |
scheduleExpression()
The cron expression used to schedule the association that you want to update.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends UpdateAssociationRequest.Builder> |
serializableBuilderClass() |
AssociationSyncCompliance |
syncCompliance()
The mode for generating association compliance.
|
String |
syncComplianceAsString()
The mode for generating association compliance.
|
List<TargetLocation> |
targetLocations()
A location is a combination of AWS Regions and AWS accounts where you want to run the association.
|
List<Target> |
targets()
The targets of the association.
|
UpdateAssociationRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
copy
public final String associationId()
The ID of the association you want to update.
public final boolean hasParameters()
public final Map<String,List<String>> parameters()
The parameters you want to update for the association. If you create a parameter using Parameter Store, you can reference the parameter using {{ssm:parameter-name}}
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasParameters()
to see if a value was sent in this field.
public final String documentVersion()
The document version you want update for the association.
public final String scheduleExpression()
The cron expression used to schedule the association that you want to update.
public final InstanceAssociationOutputLocation outputLocation()
An S3 bucket where you want to store the results of this request.
public final String name()
The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.
You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.
For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document
name. For example, AWS-ApplyPatchBaseline
or My-Document
.
You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.
For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For AWS-predefined documents and SSM documents you created in your account, you only need to specify the
document name. For example, AWS-ApplyPatchBaseline
or My-Document
.
public final boolean hasTargets()
public final List<Target> targets()
The targets of the association.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTargets()
to see if a value was sent in this field.
public final String associationName()
The name of the association that you want to update.
public final 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.
$LATEST
, or omit this parameter.public final String automationTargetParameterName()
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
public final String maxErrors()
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.
Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
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 final String maxConcurrency()
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.
If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.
public final AssociationComplianceSeverity complianceSeverity()
The severity level to assign to the association.
If the service returns an enum value that is not available in the current SDK version,
complianceSeverity
will return AssociationComplianceSeverity.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from complianceSeverityAsString()
.
AssociationComplianceSeverity
public final String complianceSeverityAsString()
The severity level to assign to the association.
If the service returns an enum value that is not available in the current SDK version,
complianceSeverity
will return AssociationComplianceSeverity.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from complianceSeverityAsString()
.
AssociationComplianceSeverity
public final 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 action. In this case, compliance data is not managed by State Manager. It is
managed by your direct call to the PutComplianceItems API action.
By default, all associations use AUTO
mode.
If the service returns an enum value that is not available in the current SDK version, syncCompliance
will return AssociationSyncCompliance.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from syncComplianceAsString()
.
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 action. In this case, compliance data is not managed by State Manager. It
is managed by your direct call to the PutComplianceItems API action.
By default, all associations use AUTO
mode.
AssociationSyncCompliance
public final String syncComplianceAsString()
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 action. In this case, compliance data is not managed by State Manager. It is
managed by your direct call to the PutComplianceItems API action.
By default, all associations use AUTO
mode.
If the service returns an enum value that is not available in the current SDK version, syncCompliance
will return AssociationSyncCompliance.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from syncComplianceAsString()
.
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 action. In this case, compliance data is not managed by State Manager. It
is managed by your direct call to the PutComplianceItems API action.
By default, all associations use AUTO
mode.
AssociationSyncCompliance
public final 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 is not supported for rate expressions.
Also, if you specified this option when you created the association, you can reset it. 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.
Also, if you specified this option when you created the association, you can reset it. 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 final boolean hasTargetLocations()
public final List<TargetLocation> targetLocations()
A location is a combination of AWS Regions and AWS accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTargetLocations()
to see if a value was sent in this field.
public UpdateAssociationRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<UpdateAssociationRequest.Builder,UpdateAssociationRequest>
toBuilder
in class SsmRequest
public static UpdateAssociationRequest.Builder builder()
public static Class<? extends UpdateAssociationRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.