Interface CreateAssociationRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateAssociationRequest.Builder,CreateAssociationRequest>, SdkBuilder<CreateAssociationRequest.Builder,CreateAssociationRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder
Enclosing class:
CreateAssociationRequest

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

    • 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 Amazon Web Services account.

      For Systems Manager documents (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:partition: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 Amazon Web Services account.

      For Systems Manager documents (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:partition: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.
    • documentVersion

      CreateAssociationRequest.Builder documentVersion(String documentVersion)

      The document version you want to associate with the targets. Can be a specific version or the default version.

      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 to associate with the targets. Can be a specific version or the default version.

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

      CreateAssociationRequest.Builder instanceId(String 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

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

      The parameters for the runtime configuration of the document.

      Parameters:
      parameters - The parameters for the runtime configuration of the document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • targets

      The targets for the association. You can target managed nodes by using tags, Amazon Web Services resource groups, all managed nodes in an Amazon Web Services account, or individual managed node IDs. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *. For more information about choosing targets for an association, see About targets and rate controls in State Manager associations in the Amazon Web Services Systems Manager User Guide.

      Parameters:
      targets - The targets for the association. You can target managed nodes by using tags, Amazon Web Services resource groups, all managed nodes in an Amazon Web Services account, or individual managed node IDs. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *. For more information about choosing targets for an association, see About targets and rate controls in State Manager associations in the Amazon Web Services Systems Manager User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • targets

      The targets for the association. You can target managed nodes by using tags, Amazon Web Services resource groups, all managed nodes in an Amazon Web Services account, or individual managed node IDs. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *. For more information about choosing targets for an association, see About targets and rate controls in State Manager associations in the Amazon Web Services Systems Manager User Guide.

      Parameters:
      targets - The targets for the association. You can target managed nodes by using tags, Amazon Web Services resource groups, all managed nodes in an Amazon Web Services account, or individual managed node IDs. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *. For more information about choosing targets for an association, see About targets and rate controls in State Manager associations in the Amazon Web Services Systems Manager User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • targets

      The targets for the association. You can target managed nodes by using tags, Amazon Web Services resource groups, all managed nodes in an Amazon Web Services account, or individual managed node IDs. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *. For more information about choosing targets for an association, see About targets and rate controls in State Manager associations in the Amazon Web Services Systems Manager User Guide.

      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

      CreateAssociationRequest.Builder scheduleExpression(String scheduleExpression)

      A cron expression when the association will be applied to the targets.

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

      An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.

      Parameters:
      outputLocation - An Amazon Simple Storage Service (Amazon 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 Amazon Simple Storage Service (Amazon 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:
    • associationName

      CreateAssociationRequest.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.
    • automationTargetParameterName

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

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

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

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

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

      CreateAssociationRequest.Builder applyOnlyAtCronInterval(Boolean applyOnlyAtCronInterval)

      By default, when you create a new association, 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 association, 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

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

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

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

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

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

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

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

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

      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

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

      CreateAssociationRequest.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.
    • tags

      Adds or overwrites one or more tags for a State Manager association. Tags are metadata that you can assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.

      Parameters:
      tags - Adds or overwrites one or more tags for a State Manager association. Tags are metadata that you can assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tags

      Adds or overwrites one or more tags for a State Manager association. Tags are metadata that you can assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.

      Parameters:
      tags - Adds or overwrites one or more tags for a State Manager association. Tags are metadata that you can assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tags

      Adds or overwrites one or more tags for a State Manager association. Tags are metadata that you can assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.

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

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

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

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

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

      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.