UpdateAssociationRequest (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.13.0 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ssm.model.SsmRequest
    - - software.amazon.awssdk.services.ssm.model.UpdateAssociationRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UpdateAssociationRequest.Builder,UpdateAssociationRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateAssociationRequest
extends SsmRequest
implements ToCopyableBuilder<UpdateAssociationRequest.Builder,UpdateAssociationRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UpdateAssociationRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`UpdateAssociationRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`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`	`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 Amazon 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()`
`List<Target>`	`targets()` The targets of the association.
`UpdateAssociationRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - associationId
```
public String associationId()
```
    The ID of the association you want to update.
    
    Returns:
    
    The ID of the association you want to update.
  - hasParameters
```
public 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). For responses returned by the SDK, the sender is the AWS service.
  - parameters
```
public 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.
    
    Returns:
    
    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}}
  - documentVersion
```
public String documentVersion()
```
    The document version you want update for the association.
    
    Returns:
    
    The document version you want update for the association.
  - scheduleExpression
```
public String scheduleExpression()
```
    The cron expression used to schedule the association that you want to update.
    
    Returns:
    
    The cron expression used to schedule the association that you want to update.
  - outputLocation
```
public InstanceAssociationOutputLocation outputLocation()
```
    An Amazon S3 bucket where you want to store the results of this request.
    
    Returns:
    
    An Amazon S3 bucket where you want to store the results of this request.
  - name
```
public 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.
    
    Returns:
    
    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.
  - hasTargets
```
public 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). For responses returned by the SDK, the sender is the AWS service.
  - targets
```
public 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.
    
    Returns:
    
    The targets of the association.
  - associationName
```
public String associationName()
```
    The name of the association that you want to update.
    
    Returns:
    
    The name of the association that you want to update.
  - associationVersion
```
public 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.
    
    Returns:
    
    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.
  - automationTargetParameterName
```
public 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.
    
    Returns:
    
    Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
  - maxErrors
```
public 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.
    
    Returns:
    
    The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.
    
    Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
  - maxConcurrency
```
public 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.
    
    Returns:
    
    The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
    
    If a new instance starts and attempts to 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.
  - complianceSeverity
```
public 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().
    
    Returns:
    
    The severity level to assign to the association.
    
    See Also:
    
    AssociationComplianceSeverity
  - complianceSeverityAsString
```
public 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().
    
    Returns:
    
    The severity level to assign to the association.
    
    See Also:
    
    AssociationComplianceSeverity
  - toBuilder
```
public UpdateAssociationRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateAssociationRequest.Builder,UpdateAssociationRequest>
    
    Specified by:
    
    toBuilder in class SsmRequest
  - builder
```
public static UpdateAssociationRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateAssociationRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UpdateAssociationRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

associationId

hasParameters

parameters

documentVersion

scheduleExpression

outputLocation

name

hasTargets

targets

associationName

associationVersion

automationTargetParameterName

maxErrors

maxConcurrency

complianceSeverity

complianceSeverityAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields