UpdateAssociationRequest (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.20.67 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
`AlarmConfiguration`	`alarmConfiguration()` Returns the value of the AlarmConfiguration property for this object.
`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()` Choose the parameter that will define how your automation will branch out.
`static UpdateAssociationRequest.Builder`	`builder()`
`List<String>`	`calendarNames()` The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under.
`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)`
`boolean`	`hasCalendarNames()` For responses, this returns true if the service returned a value for the CalendarNames property.
`int`	`hashCode()`
`boolean`	`hasParameters()` For responses, this returns true if the service returned a value for the Parameters property.
`boolean`	`hasTargetLocations()` For responses, this returns true if the service returned a value for the TargetLocations property.
`boolean`	`hasTargetMaps()` For responses, this returns true if the service returned a value for the TargetMaps property.
`boolean`	`hasTargets()` For responses, this returns true if the service returned a value for the Targets property.
`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 Command document or Automation runbook that contains the configuration information for the managed node.
`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.
`Integer`	`scheduleOffset()` Number of days to wait after the scheduled day to run an association.
`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 Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.
`List<Map<String,List<String>>>`	`targetMaps()` A key-value mapping of document parameters to target resources.
`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 final String associationId()
```
    The ID of the association you want to update.
    
    Returns:
    
    The ID of the association you want to update.
  - hasParameters
```
public final boolean hasParameters()
```
    For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - parameters
```
public final 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}}.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameters() method.
    
    Returns:
    
    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}}.
  - documentVersion
```
public final 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.
    
    Returns:
    
    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.
  - scheduleExpression
```
public final 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 final InstanceAssociationOutputLocation outputLocation()
```
    An S3 bucket where you want to store the results of this request.
    
    Returns:
    
    An S3 bucket where you want to store the results of this request.
  - name
```
public final 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.
    
    Returns:
    
    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.
  - hasTargets
```
public final boolean hasTargets()
```
    For responses, this returns true if the service returned a value for the Targets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - targets
```
public final List<Target> targets()
```
    The targets of the association.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargets() method.
    
    Returns:
    
    The targets of the association.
  - associationName
```
public final 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 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.
    
    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 final 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.
    
    Returns:
    
    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.
  - maxErrors
```
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 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.
    
    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 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.
  - maxConcurrency
```
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 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.
    
    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 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.
  - complianceSeverity
```
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().
    
    Returns:
    
    The severity level to assign to the association.
    
    See Also:
    
    AssociationComplianceSeverity
  - complianceSeverityAsString
```
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().
    
    Returns:
    
    The severity level to assign to the association.
    
    See Also:
    
    AssociationComplianceSeverity
  - syncCompliance
```
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 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.
    
    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().
    
    Returns:
    
    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.
    
    See Also:
    
    AssociationSyncCompliance
  - syncComplianceAsString
```
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 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.
    
    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().
    
    Returns:
    
    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.
    
    See Also:
    
    AssociationSyncCompliance
  - applyOnlyAtCronInterval
```
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 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.
    
    Returns:
    
    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.
  - hasCalendarNames
```
public final boolean hasCalendarNames()
```
    For responses, this returns true if the service returned a value for the CalendarNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - calendarNames
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCalendarNames() method.
    
    Returns:
    
    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.
  - hasTargetLocations
```
public final boolean hasTargetLocations()
```
    For responses, this returns true if the service returned a value for the TargetLocations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - targetLocations
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargetLocations() method.
    
    Returns:
    
    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.
  - scheduleOffset
```
public final 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.
    
    Returns:
    
    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.
  - hasTargetMaps
```
public final boolean hasTargetMaps()
```
    For responses, this returns true if the service returned a value for the TargetMaps property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - targetMaps
```
public final List<Map<String,List<String>>> targetMaps()
```
    A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargetMaps() method.
    
    Returns:
    
    A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
  - alarmConfiguration
```
public final AlarmConfiguration alarmConfiguration()
```
    Returns the value of the AlarmConfiguration property for this object.
    
    Returns:
    
    The value of the AlarmConfiguration property for this object.
  - 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 final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final 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

syncCompliance

syncComplianceAsString

applyOnlyAtCronInterval

hasCalendarNames

calendarNames

hasTargetLocations

targetLocations

scheduleOffset

hasTargetMaps

targetMaps

alarmConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields