public static interface CreateAssociationBatchRequestEntry.Builder extends SdkPojo, CopyableBuilder<CreateAssociationBatchRequestEntry.Builder,CreateAssociationBatchRequestEntry>
| Modifier and Type | Method and Description |
|---|---|
CreateAssociationBatchRequestEntry.Builder |
alarmConfiguration(AlarmConfiguration alarmConfiguration)
Sets the value of the AlarmConfiguration property for this object.
|
default CreateAssociationBatchRequestEntry.Builder |
alarmConfiguration(Consumer<AlarmConfiguration.Builder> 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(Collection<String> calendarNames)
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated
under.
|
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 |
complianceSeverity(AssociationComplianceSeverity complianceSeverity)
The severity level to assign to the association.
|
CreateAssociationBatchRequestEntry.Builder |
complianceSeverity(String 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(AssociationSyncCompliance syncCompliance)
The mode for generating association compliance.
|
CreateAssociationBatchRequestEntry.Builder |
syncCompliance(String 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.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateAssociationBatchRequestEntry.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 or My-Document.
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.
CreateAssociationBatchRequestEntry.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.
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.
CreateAssociationBatchRequestEntry.Builder parameters(Map<String,? extends Collection<String>> parameters)
A description of the parameters for a document.
parameters - A description of the parameters for a document.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.
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.CreateAssociationBatchRequestEntry.Builder documentVersion(String documentVersion)
The document version.
documentVersion - The document version.CreateAssociationBatchRequestEntry.Builder targets(Collection<Target> targets)
The managed nodes targeted by the request.
targets - The managed nodes targeted by the request.CreateAssociationBatchRequestEntry.Builder targets(Target... targets)
The managed nodes targeted by the request.
targets - The managed nodes targeted by the request.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 via
Target.builder().
When the Consumer completes, SdkBuilder.build()
is called immediately and its result is passed to #targets(List.
targets - a consumer that will call methods on Target.Builder#targets(java.util.Collection) CreateAssociationBatchRequestEntry.Builder scheduleExpression(String scheduleExpression)
A cron expression that specifies a schedule when the association runs.
scheduleExpression - A cron expression that specifies a schedule when the association runs.CreateAssociationBatchRequestEntry.Builder outputLocation(InstanceAssociationOutputLocation outputLocation)
An S3 bucket where you want to store the results of this request.
outputLocation - An S3 bucket where you want to store the results of this request.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 via
InstanceAssociationOutputLocation.builder().
When the Consumer completes, SdkBuilder.build() is called
immediately and its result is passed to outputLocation(InstanceAssociationOutputLocation).
outputLocation - a consumer that will call methods on InstanceAssociationOutputLocation.BuilderoutputLocation(InstanceAssociationOutputLocation)CreateAssociationBatchRequestEntry.Builder associationName(String associationName)
Specify a descriptive name for the association.
associationName - Specify a descriptive name for the association.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, set MaxConcurrency to 1 so that executions proceed one at a time.
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.
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.
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.
CreateAssociationBatchRequestEntry.Builder complianceSeverity(String complianceSeverity)
The severity level to assign to the association.
complianceSeverity - The severity level to assign to the association.AssociationComplianceSeverity,
AssociationComplianceSeverityCreateAssociationBatchRequestEntry.Builder complianceSeverity(AssociationComplianceSeverity complianceSeverity)
The severity level to assign to the association.
complianceSeverity - The severity level to assign to the association.AssociationComplianceSeverity,
AssociationComplianceSeverityCreateAssociationBatchRequestEntry.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.
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.
AssociationSyncCompliance,
AssociationSyncComplianceCreateAssociationBatchRequestEntry.Builder syncCompliance(AssociationSyncCompliance syncCompliance)
The mode for generating association compliance. You can specify AUTO or MANUAL. In
AUTO mode, the system uses the status of the association execution to determine the compliance
status. If the association execution runs successfully, then the association is COMPLIANT. If
the association execution doesn't run successfully, the association is NON-COMPLIANT.
In MANUAL mode, you must specify the AssociationId as a parameter for the
PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a
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.
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.
AssociationSyncCompliance,
AssociationSyncComplianceCreateAssociationBatchRequestEntry.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.
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.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.
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.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.
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.CreateAssociationBatchRequestEntry.Builder targetLocations(Collection<TargetLocation> targetLocations)
Use this action to create an association in multiple Regions and multiple accounts.
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.
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.
This is a convenience method that creates an instance of theTargetLocation.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.
targetLocations - a consumer that will call methods on
TargetLocation.Builder#targetLocations(java.util.Collection) CreateAssociationBatchRequestEntry.Builder scheduleOffset(Integer scheduleOffset)
Number of days to wait after the scheduled day to run an association.
scheduleOffset - Number of days to wait after the scheduled day to run an association.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.
targetMaps - A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be
specified together.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.
targetMaps - A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be
specified together.CreateAssociationBatchRequestEntry.Builder alarmConfiguration(AlarmConfiguration alarmConfiguration)
alarmConfiguration - The new value for the AlarmConfiguration property for this object.default CreateAssociationBatchRequestEntry.Builder alarmConfiguration(Consumer<AlarmConfiguration.Builder> alarmConfiguration)
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).
alarmConfiguration - a consumer that will call methods on AlarmConfiguration.BuilderalarmConfiguration(AlarmConfiguration)Copyright © 2023. All rights reserved.