Interface UpdateAssociationRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateAssociationRequest.Builder,UpdateAssociationRequest>, SdkBuilder<UpdateAssociationRequest.Builder,UpdateAssociationRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder
Enclosing class:
UpdateAssociationRequest
@Mutable @NotThreadSafe public static interface UpdateAssociationRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<UpdateAssociationRequest.Builder,UpdateAssociationRequest>

  • Method Details

    • associationId

      UpdateAssociationRequest.Builder associationId(String associationId)

      The ID of the association you want to update.

      Parameters:
      associationId - The ID of the association you want to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      UpdateAssociationRequest.Builder parameters(Map<String,? extends Collection<String>> parameters)

      The parameters you want to update for the association. If you create a parameter using Parameter Store, a tool in Amazon Web Services Systems Manager, you can reference the parameter using {{ssm:parameter-name}}.

      Parameters:
      parameters - The parameters you want to update for the association. If you create a parameter using Parameter Store, a tool in Amazon Web Services Systems Manager, you can reference the parameter using {{ssm:parameter-name}}.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documentVersion

      UpdateAssociationRequest.Builder documentVersion(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • scheduleExpression

      UpdateAssociationRequest.Builder scheduleExpression(String scheduleExpression)

      The cron expression used to schedule the association that you want to update.

      Parameters:
      scheduleExpression - The cron expression used to schedule the association that you want to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputLocation

      UpdateAssociationRequest.Builder outputLocation(InstanceAssociationOutputLocation outputLocation)

      An S3 bucket where you want to store the results of this request.

      Parameters:
      outputLocation - An S3 bucket where you want to store the results of this request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputLocation

      default UpdateAssociationRequest.Builder outputLocation(Consumer<InstanceAssociationOutputLocation.Builder> outputLocation)

      An S3 bucket where you want to store the results of this request.

      This is a convenience method that creates an instance of the InstanceAssociationOutputLocation.Builder avoiding the need to create one manually via InstanceAssociationOutputLocation.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputLocation(InstanceAssociationOutputLocation).

      Parameters:
      outputLocation - a consumer that will call methods on InstanceAssociationOutputLocation.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • name

      UpdateAssociationRequest.Builder name(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • targets

      UpdateAssociationRequest.Builder targets(Collection<Target> targets)

      The targets of the association.

      Parameters:
      targets - The targets of the association.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targets

      UpdateAssociationRequest.Builder targets(Target... targets)

      The targets of the association.

      Parameters:
      targets - The targets of the association.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targets

      UpdateAssociationRequest.Builder targets(Consumer<Target.Builder>... targets)

      The targets of the association.

      This is a convenience method that creates an instance of the Target.Builder avoiding the need to create one manually via Target.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targets(List<Target>).

      Parameters:
      targets - a consumer that will call methods on Target.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • associationName

      UpdateAssociationRequest.Builder associationName(String associationName)

      The name of the association that you want to update.

      Parameters:
      associationName - The name of the association that you want to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • associationVersion

      UpdateAssociationRequest.Builder associationVersion(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • automationTargetParameterName

      UpdateAssociationRequest.Builder automationTargetParameterName(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 tool in Amazon Web Services Systems Manager.

      Parameters:
      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 tool in Amazon Web Services Systems Manager.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxErrors

      UpdateAssociationRequest.Builder maxErrors(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • maxConcurrency

      UpdateAssociationRequest.Builder maxConcurrency(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • complianceSeverity

      UpdateAssociationRequest.Builder complianceSeverity(String complianceSeverity)

      The severity level to assign to the association.

      Parameters:
      complianceSeverity - The severity level to assign to the association.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • complianceSeverity

      UpdateAssociationRequest.Builder complianceSeverity(AssociationComplianceSeverity complianceSeverity)

      The severity level to assign to the association.

      Parameters:
      complianceSeverity - The severity level to assign to the association.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • syncCompliance

      UpdateAssociationRequest.Builder syncCompliance(String syncCompliance)

      The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

      In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

      By default, all associations use AUTO mode.

      Parameters:
      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 tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

      By default, all associations use AUTO mode.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • syncCompliance

      UpdateAssociationRequest.Builder syncCompliance(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 tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

      By default, all associations use AUTO mode.

      Parameters:
      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 tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

      By default, all associations use AUTO mode.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • applyOnlyAtCronInterval

      UpdateAssociationRequest.Builder applyOnlyAtCronInterval(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 true for ApplyOnlyAtCronInterval if you want the association to run only according to the schedule you specified.

      If you chose this option when you created an association and later you edit that association or you make changes to the Automation runbook or SSM document on which that association is based, 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 set ApplyOnlyAtCronInterval to true. If this option wasn't selected, State Manager immediately runs the association.

      For more information, see Understanding when associations are applied to resources and About target updates with Automation runbooks in the Amazon Web Services Systems Manager User Guide.

      This parameter isn't supported for rate expressions.

      You can reset this parameter. 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.

      Parameters:
      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 true for ApplyOnlyAtCronInterval if you want the association to run only according to the schedule you specified.

      If you chose this option when you created an association and later you edit that association or you make changes to the Automation runbook or SSM document on which that association is based, 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 set ApplyOnlyAtCronInterval to true. If this option wasn't selected, State Manager immediately runs the association.

      For more information, see Understanding when associations are applied to resources and About target updates with Automation runbooks in the Amazon Web Services Systems Manager User Guide.

      This parameter isn't supported for rate expressions.

      You can reset this parameter. 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:
      Returns a reference to this object so that method calls can be chained together.

    • calendarNames

      UpdateAssociationRequest.Builder calendarNames(Collection<String> calendarNames)

      The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.

      Parameters:
      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 in the Amazon Web Services Systems Manager User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • calendarNames

      UpdateAssociationRequest.Builder calendarNames(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 in the Amazon Web Services Systems Manager User Guide.

      Parameters:
      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 in the Amazon Web Services Systems Manager User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetLocations

      UpdateAssociationRequest.Builder targetLocations(Collection<TargetLocation> targetLocations)

      A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetLocations

      UpdateAssociationRequest.Builder targetLocations(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetLocations

      UpdateAssociationRequest.Builder targetLocations(Consumer<TargetLocation.Builder>... 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.

      This is a convenience method that creates an instance of the TargetLocation.Builder avoiding the need to create one manually via TargetLocation.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targetLocations(List<TargetLocation>).

      Parameters:
      targetLocations - a consumer that will call methods on TargetLocation.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scheduleOffset

      UpdateAssociationRequest.Builder scheduleOffset(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • duration

      UpdateAssociationRequest.Builder duration(Integer duration)

      The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.

      The Duration parameter applies only when both these conditions are true:

      • The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.

      • The command specifies the ApplyOnlyAtCronInterval parameter, which means that the association doesn't run immediately after it is updated, but only according to the specified schedule.

      Parameters:
      duration - The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.

      The Duration parameter applies only when both these conditions are true:

      • The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.

      • The command specifies the ApplyOnlyAtCronInterval parameter, which means that the association doesn't run immediately after it is updated, but only according to the specified schedule.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetMaps

      UpdateAssociationRequest.Builder targetMaps(Collection<? extends Map<String,? extends Collection<String>>> targetMaps)

      A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

      Parameters:
      targetMaps - A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetMaps

      UpdateAssociationRequest.Builder targetMaps(Map<String,? extends Collection<String>>... targetMaps)

      A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

      Parameters:
      targetMaps - A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • alarmConfiguration

      UpdateAssociationRequest.Builder alarmConfiguration(AlarmConfiguration alarmConfiguration)
      Sets the value of the AlarmConfiguration property for this object.
      Parameters:
      alarmConfiguration - The new value for the AlarmConfiguration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • alarmConfiguration

      default UpdateAssociationRequest.Builder alarmConfiguration(Consumer<AlarmConfiguration.Builder> alarmConfiguration)
      Sets the value of the AlarmConfiguration property for this object. This is a convenience method that creates an instance of the AlarmConfiguration.Builder avoiding the need to create one manually via AlarmConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to alarmConfiguration(AlarmConfiguration).

      Parameters:
      alarmConfiguration - a consumer that will call methods on AlarmConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      UpdateAssociationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateAssociationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.