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 Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default CreateAssociationBatchRequestEntry.Builder
alarmConfiguration(Consumer<AlarmConfiguration.Builder> alarmConfiguration)
Sets the value of the AlarmConfiguration property for this object.CreateAssociationBatchRequestEntry.Builder
alarmConfiguration(AlarmConfiguration alarmConfiguration)
Sets the value of the AlarmConfiguration property for this object.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.CreateAssociationBatchRequestEntry.Builder
associationName(String associationName)
Specify a descriptive name for the association.CreateAssociationBatchRequestEntry.Builder
automationTargetParameterName(String automationTargetParameterName)
Specify the target for the association.CreateAssociationBatchRequestEntry.Builder
calendarNames(String... calendarNames)
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.CreateAssociationBatchRequestEntry.Builder
calendarNames(Collection<String> calendarNames)
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.CreateAssociationBatchRequestEntry.Builder
complianceSeverity(String complianceSeverity)
The severity level to assign to the association.CreateAssociationBatchRequestEntry.Builder
complianceSeverity(AssociationComplianceSeverity complianceSeverity)
The severity level to assign to the association.CreateAssociationBatchRequestEntry.Builder
documentVersion(String documentVersion)
The document version.CreateAssociationBatchRequestEntry.Builder
instanceId(String instanceId)
The managed node ID.CreateAssociationBatchRequestEntry.Builder
maxConcurrency(String maxConcurrency)
The maximum number of targets allowed to run the association at the same time.CreateAssociationBatchRequestEntry.Builder
maxErrors(String maxErrors)
The number of errors that are allowed before the system stops sending requests to run the association on additional targets.CreateAssociationBatchRequestEntry.Builder
name(String name)
The name of the SSM document that contains the configuration information for the managed node.default CreateAssociationBatchRequestEntry.Builder
outputLocation(Consumer<InstanceAssociationOutputLocation.Builder> outputLocation)
An S3 bucket where you want to store the results of this request.CreateAssociationBatchRequestEntry.Builder
outputLocation(InstanceAssociationOutputLocation outputLocation)
An S3 bucket where you want to store the results of this request.CreateAssociationBatchRequestEntry.Builder
parameters(Map<String,? extends Collection<String>> parameters)
A description of the parameters for a document.CreateAssociationBatchRequestEntry.Builder
scheduleExpression(String scheduleExpression)
A cron expression that specifies a schedule when the association runs.CreateAssociationBatchRequestEntry.Builder
scheduleOffset(Integer scheduleOffset)
Number of days to wait after the scheduled day to run an association.CreateAssociationBatchRequestEntry.Builder
syncCompliance(String syncCompliance)
The mode for generating association compliance.CreateAssociationBatchRequestEntry.Builder
syncCompliance(AssociationSyncCompliance syncCompliance)
The mode for generating association compliance.CreateAssociationBatchRequestEntry.Builder
targetLocations(Collection<TargetLocation> targetLocations)
Use this action to create an association in multiple Regions and multiple accounts.CreateAssociationBatchRequestEntry.Builder
targetLocations(Consumer<TargetLocation.Builder>... targetLocations)
Use this action to create an association in multiple Regions and multiple accounts.CreateAssociationBatchRequestEntry.Builder
targetLocations(TargetLocation... targetLocations)
Use this action to create an association in multiple Regions and multiple accounts.CreateAssociationBatchRequestEntry.Builder
targetMaps(Collection<? extends Map<String,? extends Collection<String>>> targetMaps)
A key-value mapping of document parameters to target resources.CreateAssociationBatchRequestEntry.Builder
targetMaps(Map<String,? extends Collection<String>>... targetMaps)
A key-value mapping of document parameters to target resources.CreateAssociationBatchRequestEntry.Builder
targets(Collection<Target> targets)
The managed nodes targeted by the request.CreateAssociationBatchRequestEntry.Builder
targets(Consumer<Target.Builder>... targets)
The managed nodes targeted by the request.CreateAssociationBatchRequestEntry.Builder
targets(Target... targets)
The managed nodes targeted by the request.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
name
CreateAssociationBatchRequestEntry.Builder name(String 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
orMy-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
orMy-Document
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceId
CreateAssociationBatchRequestEntry.Builder instanceId(String instanceId)
The managed node ID.
InstanceId
has been deprecated. To specify a managed node ID for an association, use theTargets
parameter. Requests that include the parameterInstanceID
with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameterInstanceId
, you can't use the parametersAssociationName
,DocumentVersion
,MaxErrors
,MaxConcurrency
,OutputLocation
, orScheduleExpression
. To use these parameters, you must use theTargets
parameter.- Parameters:
instanceId
- The managed node ID.InstanceId
has been deprecated. To specify a managed node ID for an association, use theTargets
parameter. Requests that include the parameterInstanceID
with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameterInstanceId
, you can't use the parametersAssociationName
,DocumentVersion
,MaxErrors
,MaxConcurrency
,OutputLocation
, orScheduleExpression
. To use these parameters, you must use theTargets
parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameters
CreateAssociationBatchRequestEntry.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.
-
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
CreateAssociationBatchRequestEntry.Builder targets(Collection<Target> 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
CreateAssociationBatchRequestEntry.Builder targets(Target... 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
CreateAssociationBatchRequestEntry.Builder targets(Consumer<Target.Builder>... targets)
The managed nodes targeted by the request.
This is a convenience method that creates an instance of theTarget.Builder
avoiding the need to create one manually viaTarget.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#targets(List
.) - Parameters:
targets
- a consumer that will call methods onTarget.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#targets(java.util.Collection
)
-
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
CreateAssociationBatchRequestEntry.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 CreateAssociationBatchRequestEntry.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 theInstanceAssociationOutputLocation.Builder
avoiding the need to create one manually viaInstanceAssociationOutputLocation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooutputLocation(InstanceAssociationOutputLocation)
.- Parameters:
outputLocation
- a consumer that will call methods onInstanceAssociationOutputLocation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
outputLocation(InstanceAssociationOutputLocation)
-
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
CreateAssociationBatchRequestEntry.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, setMaxConcurrency
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 setMaxError
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, setMaxConcurrency
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 forMaxConcurrency
.- 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 forMaxConcurrency
.- 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:
AssociationComplianceSeverity
,AssociationComplianceSeverity
-
complianceSeverity
CreateAssociationBatchRequestEntry.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:
AssociationComplianceSeverity
,AssociationComplianceSeverity
-
syncCompliance
CreateAssociationBatchRequestEntry.Builder syncCompliance(String syncCompliance)
The mode for generating association compliance. You can specify
AUTO
orMANUAL
. InAUTO
mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association isCOMPLIANT
. If the association execution doesn't run successfully, the association isNON-COMPLIANT
.In
MANUAL
mode, you must specify theAssociationId
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 specifyAUTO
orMANUAL
. InAUTO
mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association isCOMPLIANT
. If the association execution doesn't run successfully, the association isNON-COMPLIANT
.In
MANUAL
mode, you must specify theAssociationId
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:
AssociationSyncCompliance
,AssociationSyncCompliance
-
syncCompliance
CreateAssociationBatchRequestEntry.Builder syncCompliance(AssociationSyncCompliance syncCompliance)
The mode for generating association compliance. You can specify
AUTO
orMANUAL
. InAUTO
mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association isCOMPLIANT
. If the association execution doesn't run successfully, the association isNON-COMPLIANT
.In
MANUAL
mode, you must specify theAssociationId
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 specifyAUTO
orMANUAL
. InAUTO
mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association isCOMPLIANT
. If the association execution doesn't run successfully, the association isNON-COMPLIANT
.In
MANUAL
mode, you must specify theAssociationId
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:
AssociationSyncCompliance
,AssociationSyncCompliance
-
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
CreateAssociationBatchRequestEntry.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
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
CreateAssociationBatchRequestEntry.Builder targetLocations(Collection<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
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
CreateAssociationBatchRequestEntry.Builder targetLocations(Consumer<TargetLocation.Builder>... targetLocations)
Use this action to create an association in multiple Regions and multiple accounts.
This is a convenience method that creates an instance of theTargetLocation.Builder
avoiding the need to create one manually viaTargetLocation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#targetLocations(List
.) - Parameters:
targetLocations
- a consumer that will call methods onTargetLocation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#targetLocations(java.util.Collection
)
-
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.
-
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
CreateAssociationBatchRequestEntry.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
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 theAlarmConfiguration.Builder
avoiding the need to create one manually viaAlarmConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toalarmConfiguration(AlarmConfiguration)
.- Parameters:
alarmConfiguration
- a consumer that will call methods onAlarmConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
alarmConfiguration(AlarmConfiguration)
-
-