Interface AssociationDescription.Builder

All Superinterfaces:
Buildable, CopyableBuilder<AssociationDescription.Builder,AssociationDescription>, SdkBuilder<AssociationDescription.Builder,AssociationDescription>, SdkPojo
Enclosing class:
AssociationDescription

public static interface AssociationDescription.Builder extends SdkPojo, CopyableBuilder<AssociationDescription.Builder,AssociationDescription>
  • Method Details

    • name

      The name of the SSM document.

      Parameters:
      name - The name of the SSM document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • instanceId

      AssociationDescription.Builder instanceId(String instanceId)

      The managed node ID.

      Parameters:
      instanceId - The managed node ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • associationVersion

      AssociationDescription.Builder associationVersion(String associationVersion)

      The association version.

      Parameters:
      associationVersion - The association version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • date

      The date when the association was made.

      Parameters:
      date - The date when the association was made.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • lastUpdateAssociationDate

      AssociationDescription.Builder lastUpdateAssociationDate(Instant lastUpdateAssociationDate)

      The date when the association was last updated.

      Parameters:
      lastUpdateAssociationDate - The date when the association was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • status

      The association status.

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

      The association status.

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

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

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

      Information about the association.

      Parameters:
      overview - Information about the association.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • overview

      Information about the association.

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

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

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

      AssociationDescription.Builder documentVersion(String documentVersion)

      The document version.

      Parameters:
      documentVersion - The document version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • automationTargetParameterName

      AssociationDescription.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 capability of 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 capability of Amazon Web Services Systems Manager.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • parameters

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

      A description of the parameters for a document.

      Parameters:
      parameters - A description of the parameters for a document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • associationId

      AssociationDescription.Builder associationId(String associationId)

      The association ID.

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

      The managed nodes targeted by the request.

      Parameters:
      targets - The managed nodes targeted by the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • targets

      The managed nodes targeted by the request.

      Parameters:
      targets - The managed nodes targeted by the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • targets

      The managed nodes targeted by the request.

      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:
    • scheduleExpression

      AssociationDescription.Builder scheduleExpression(String scheduleExpression)

      A cron expression that specifies a schedule when the association runs.

      Parameters:
      scheduleExpression - A cron expression that specifies a schedule when the association runs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • outputLocation

      An S3 bucket where you want to store the output details of the request.

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

      An S3 bucket where you want to store the output details of the 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:
    • lastExecutionDate

      AssociationDescription.Builder lastExecutionDate(Instant lastExecutionDate)

      The date on which the association was last run.

      Parameters:
      lastExecutionDate - The date on which the association was last run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • lastSuccessfulExecutionDate

      AssociationDescription.Builder lastSuccessfulExecutionDate(Instant lastSuccessfulExecutionDate)

      The last date on which the association was successfully run.

      Parameters:
      lastSuccessfulExecutionDate - The last date on which the association was successfully run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • associationName

      AssociationDescription.Builder associationName(String associationName)

      The association name.

      Parameters:
      associationName - The association name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • maxErrors

      AssociationDescription.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

      AssociationDescription.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

      AssociationDescription.Builder complianceSeverity(String complianceSeverity)

      The severity level that is assigned to the association.

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

      AssociationDescription.Builder complianceSeverity(AssociationComplianceSeverity complianceSeverity)

      The severity level that is assigned to the association.

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

      AssociationDescription.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 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.

      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 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.

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

      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 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.

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

      AssociationDescription.Builder applyOnlyAtCronInterval(Boolean applyOnlyAtCronInterval)

      By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.

      Parameters:
      applyOnlyAtCronInterval - By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • calendarNames

      AssociationDescription.Builder calendarNames(Collection<String> calendarNames)

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

      Parameters:
      calendarNames - The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • calendarNames

      AssociationDescription.Builder calendarNames(String... calendarNames)

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

      Parameters:
      calendarNames - The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • targetLocations

      AssociationDescription.Builder targetLocations(Collection<TargetLocation> targetLocations)

      The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.

      Parameters:
      targetLocations - The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • targetLocations

      AssociationDescription.Builder targetLocations(TargetLocation... targetLocations)

      The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.

      Parameters:
      targetLocations - The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • targetLocations

      AssociationDescription.Builder targetLocations(Consumer<TargetLocation.Builder>... targetLocations)

      The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.

      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

      AssociationDescription.Builder scheduleOffset(Integer scheduleOffset)

      Number of days to wait after the scheduled day to run an association.

      Parameters:
      scheduleOffset - Number of days to wait after the scheduled day to run an association.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • duration

      The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.

      Parameters:
      duration - The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • targetMaps

      AssociationDescription.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

      AssociationDescription.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

      AssociationDescription.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 AssociationDescription.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:
    • triggeredAlarms

      The CloudWatch alarm that was invoked during the association.

      Parameters:
      triggeredAlarms - The CloudWatch alarm that was invoked during the association.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • triggeredAlarms

      AssociationDescription.Builder triggeredAlarms(AlarmStateInformation... triggeredAlarms)

      The CloudWatch alarm that was invoked during the association.

      Parameters:
      triggeredAlarms - The CloudWatch alarm that was invoked during the association.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • triggeredAlarms

      The CloudWatch alarm that was invoked during the association.

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

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

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