public static interface AssociationDescription.Builder extends SdkPojo, CopyableBuilder<AssociationDescription.Builder,AssociationDescription>
Modifier and Type | Method and Description |
---|---|
AssociationDescription.Builder |
applyOnlyAtCronInterval(Boolean applyOnlyAtCronInterval)
By default, when you create a new associations, the system runs it immediately after it is created and then
according to the schedule you specified.
|
AssociationDescription.Builder |
associationId(String associationId)
The association ID.
|
AssociationDescription.Builder |
associationName(String associationName)
The association name.
|
AssociationDescription.Builder |
associationVersion(String associationVersion)
The association version.
|
AssociationDescription.Builder |
automationTargetParameterName(String automationTargetParameterName)
Specify the target for the association.
|
AssociationDescription.Builder |
complianceSeverity(AssociationComplianceSeverity complianceSeverity)
The severity level that is assigned to the association.
|
AssociationDescription.Builder |
complianceSeverity(String complianceSeverity)
The severity level that is assigned to the association.
|
AssociationDescription.Builder |
date(Instant date)
The date when the association was made.
|
AssociationDescription.Builder |
documentVersion(String documentVersion)
The document version.
|
AssociationDescription.Builder |
instanceId(String instanceId)
The ID of the instance.
|
AssociationDescription.Builder |
lastExecutionDate(Instant lastExecutionDate)
The date on which the association was last run.
|
AssociationDescription.Builder |
lastSuccessfulExecutionDate(Instant lastSuccessfulExecutionDate)
The last date on which the association was successfully run.
|
AssociationDescription.Builder |
lastUpdateAssociationDate(Instant lastUpdateAssociationDate)
The date when the association was last updated.
|
AssociationDescription.Builder |
maxConcurrency(String maxConcurrency)
The maximum number of targets allowed to run the association at the same time.
|
AssociationDescription.Builder |
maxErrors(String maxErrors)
The number of errors that are allowed before the system stops sending requests to run the association on
additional targets.
|
AssociationDescription.Builder |
name(String name)
The name of the Systems Manager document.
|
default AssociationDescription.Builder |
outputLocation(Consumer<InstanceAssociationOutputLocation.Builder> outputLocation)
An S3 bucket where you want to store the output details of the request.
|
AssociationDescription.Builder |
outputLocation(InstanceAssociationOutputLocation outputLocation)
An S3 bucket where you want to store the output details of the request.
|
AssociationDescription.Builder |
overview(AssociationOverview overview)
Information about the association.
|
default AssociationDescription.Builder |
overview(Consumer<AssociationOverview.Builder> overview)
Information about the association.
|
AssociationDescription.Builder |
parameters(Map<String,? extends Collection<String>> parameters)
A description of the parameters for a document.
|
AssociationDescription.Builder |
scheduleExpression(String scheduleExpression)
A cron expression that specifies a schedule when the association runs.
|
AssociationDescription.Builder |
status(AssociationStatus status)
The association status.
|
default AssociationDescription.Builder |
status(Consumer<AssociationStatus.Builder> status)
The association status.
|
AssociationDescription.Builder |
syncCompliance(AssociationSyncCompliance syncCompliance)
The mode for generating association compliance.
|
AssociationDescription.Builder |
syncCompliance(String syncCompliance)
The mode for generating association compliance.
|
AssociationDescription.Builder |
targetLocations(Collection<TargetLocation> targetLocations)
The combination of AWS Regions and AWS accounts where you want to run the association.
|
AssociationDescription.Builder |
targetLocations(Consumer<TargetLocation.Builder>... targetLocations)
The combination of AWS Regions and AWS accounts where you want to run the association.
|
AssociationDescription.Builder |
targetLocations(TargetLocation... targetLocations)
The combination of AWS Regions and AWS accounts where you want to run the association.
|
AssociationDescription.Builder |
targets(Collection<Target> targets)
The instances targeted by the request.
|
AssociationDescription.Builder |
targets(Consumer<Target.Builder>... targets)
The instances targeted by the request.
|
AssociationDescription.Builder |
targets(Target... targets)
The instances targeted by the request.
|
equalsBySdkFields, sdkFields
copy
applyMutation, build
AssociationDescription.Builder name(String name)
The name of the Systems Manager document.
name
- The name of the Systems Manager document.AssociationDescription.Builder instanceId(String instanceId)
The ID of the instance.
instanceId
- The ID of the instance.AssociationDescription.Builder associationVersion(String associationVersion)
The association version.
associationVersion
- The association version.AssociationDescription.Builder date(Instant date)
The date when the association was made.
date
- The date when the association was made.AssociationDescription.Builder lastUpdateAssociationDate(Instant lastUpdateAssociationDate)
The date when the association was last updated.
lastUpdateAssociationDate
- The date when the association was last updated.AssociationDescription.Builder status(AssociationStatus status)
The association status.
status
- The association status.default AssociationDescription.Builder status(Consumer<AssociationStatus.Builder> status)
The association status.
This is a convenience that creates an instance of theAssociationStatus.Builder
avoiding the need to
create one manually via AssociationStatus.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to status(AssociationStatus)
.status
- a consumer that will call methods on AssociationStatus.Builder
status(AssociationStatus)
AssociationDescription.Builder overview(AssociationOverview overview)
Information about the association.
overview
- Information about the association.default AssociationDescription.Builder overview(Consumer<AssociationOverview.Builder> overview)
Information about the association.
This is a convenience that creates an instance of theAssociationOverview.Builder
avoiding the need
to create one manually via AssociationOverview.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and
its result is passed to overview(AssociationOverview)
.overview
- a consumer that will call methods on AssociationOverview.Builder
overview(AssociationOverview)
AssociationDescription.Builder documentVersion(String documentVersion)
The document version.
documentVersion
- The document version.AssociationDescription.Builder automationTargetParameterName(String automationTargetParameterName)
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
automationTargetParameterName
- Specify the target for the association. This target is required for associations that use an
Automation document and target resources by using rate controls.AssociationDescription.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.AssociationDescription.Builder associationId(String associationId)
The association ID.
associationId
- The association ID.AssociationDescription.Builder targets(Collection<Target> targets)
The instances targeted by the request.
targets
- The instances targeted by the request.AssociationDescription.Builder targets(Target... targets)
The instances targeted by the request.
targets
- The instances targeted by the request.AssociationDescription.Builder targets(Consumer<Target.Builder>... targets)
The instances targeted by the request.
This is a convenience that creates an instance of theList.Builder
avoiding the need to
create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its
result is passed to #targets(List)
.targets
- a consumer that will call methods on List.Builder
#targets(List)
AssociationDescription.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.AssociationDescription.Builder outputLocation(InstanceAssociationOutputLocation outputLocation)
An S3 bucket where you want to store the output details of the request.
outputLocation
- An S3 bucket where you want to store the output details of the request.default AssociationDescription.Builder outputLocation(Consumer<InstanceAssociationOutputLocation.Builder> outputLocation)
An S3 bucket where you want to store the output details of the request.
This is a convenience 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.Builder
outputLocation(InstanceAssociationOutputLocation)
AssociationDescription.Builder lastExecutionDate(Instant lastExecutionDate)
The date on which the association was last run.
lastExecutionDate
- The date on which the association was last run.AssociationDescription.Builder lastSuccessfulExecutionDate(Instant lastSuccessfulExecutionDate)
The last date on which the association was successfully run.
lastSuccessfulExecutionDate
- The last date on which the association was successfully run.AssociationDescription.Builder associationName(String associationName)
The association name.
associationName
- The association name.AssociationDescription.Builder maxErrors(String maxErrors)
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances 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 instances 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.
AssociationDescription.Builder maxConcurrency(String maxConcurrency)
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
If a new instance 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 instance 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 instance 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 instance will process its association within the limit specified for MaxConcurrency.
AssociationDescription.Builder complianceSeverity(String complianceSeverity)
The severity level that is assigned to the association.
complianceSeverity
- The severity level that is assigned to the association.AssociationComplianceSeverity
,
AssociationComplianceSeverity
AssociationDescription.Builder complianceSeverity(AssociationComplianceSeverity complianceSeverity)
The severity level that is assigned to the association.
complianceSeverity
- The severity level that is assigned to the association.AssociationComplianceSeverity
,
AssociationComplianceSeverity
AssociationDescription.Builder syncCompliance(String syncCompliance)
The mode for generating association compliance. You can specify AUTO
or MANUAL
. In
AUTO
mode, the system uses the status of the association execution to determine the compliance
status. If the association execution runs successfully, then the association is COMPLIANT
. If
the association execution doesn't run successfully, the association is NON-COMPLIANT
.
In MANUAL
mode, you must specify the AssociationId
as a parameter for the
PutComplianceItems API action. In this case, compliance data is not managed by State Manager. It is
managed by your direct call to the PutComplianceItems API action.
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 action. In this case, compliance data is not managed by State Manager.
It is managed by your direct call to the PutComplianceItems API action.
By default, all associations use AUTO
mode.
AssociationSyncCompliance
,
AssociationSyncCompliance
AssociationDescription.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 action. In this case, compliance data is not managed by State Manager. It is
managed by your direct call to the PutComplianceItems API action.
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 action. In this case, compliance data is not managed by State Manager.
It is managed by your direct call to the PutComplianceItems API action.
By default, all associations use AUTO
mode.
AssociationSyncCompliance
,
AssociationSyncCompliance
AssociationDescription.Builder applyOnlyAtCronInterval(Boolean applyOnlyAtCronInterval)
By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter is not 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 is not supported for rate expressions.AssociationDescription.Builder targetLocations(Collection<TargetLocation> targetLocations)
The combination of AWS Regions and AWS accounts where you want to run the association.
targetLocations
- The combination of AWS Regions and AWS accounts where you want to run the association.AssociationDescription.Builder targetLocations(TargetLocation... targetLocations)
The combination of AWS Regions and AWS accounts where you want to run the association.
targetLocations
- The combination of AWS Regions and AWS accounts where you want to run the association.AssociationDescription.Builder targetLocations(Consumer<TargetLocation.Builder>... targetLocations)
The combination of AWS Regions and AWS accounts where you want to run the association.
This is a convenience that creates an instance of theList.Builder
avoiding the need
to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and
its result is passed to #targetLocations(List)
.targetLocations
- a consumer that will call methods on List.Builder
#targetLocations(List)
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.