Interface CreateAssociationBatchRequestEntry.Builder

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

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

    • name

      The name of the SSM document that contains the configuration information for the managed node. You can specify Command or Automation runbooks.

      You can specify Amazon Web Services-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 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 document that contains the configuration information for the managed node. You can specify Command or Automation runbooks.

      You can specify Amazon Web Services-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 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.
    • instanceId

      The managed node ID.

      InstanceId has been deprecated. To specify a managed node ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you can't use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.

      Parameters:
      instanceId - The managed node ID.

      InstanceId has been deprecated. To specify a managed node ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you can't use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.

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

      CreateAssociationBatchRequestEntry.Builder automationTargetParameterName(String automationTargetParameterName)

      Specify the target for the association. 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 - Specify the target for the association. 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.
    • documentVersion

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

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

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

      CreateAssociationBatchRequestEntry.Builder associationName(String associationName)

      Specify a descriptive name for the association.

      Parameters:
      associationName - Specify a descriptive name for the association.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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

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

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

      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

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

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

      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

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

      Use this action to create an association in multiple Regions and multiple accounts.

      Parameters:
      targetLocations - Use this action to create an association in multiple Regions and multiple accounts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • targetLocations

      CreateAssociationBatchRequestEntry.Builder targetLocations(TargetLocation... targetLocations)

      Use this action to create an association in multiple Regions and multiple accounts.

      Parameters:
      targetLocations - Use this action to create an association in multiple Regions and multiple accounts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • targetLocations

      Use this action to create 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

      CreateAssociationBatchRequestEntry.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 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 created, 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 created, but only according to the specified schedule.

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

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

      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

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