public static interface AssociationVersionInfo.Builder extends SdkPojo, CopyableBuilder<AssociationVersionInfo.Builder,AssociationVersionInfo>
Modifier and Type | Method and Description |
---|---|
AssociationVersionInfo.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.
|
AssociationVersionInfo.Builder |
associationId(String associationId)
The ID created by the system when the association was created.
|
AssociationVersionInfo.Builder |
associationName(String associationName)
The name specified for the association version when the association version was created.
|
AssociationVersionInfo.Builder |
associationVersion(String associationVersion)
The association version.
|
AssociationVersionInfo.Builder |
complianceSeverity(AssociationComplianceSeverity complianceSeverity)
The severity level that is assigned to the association.
|
AssociationVersionInfo.Builder |
complianceSeverity(String complianceSeverity)
The severity level that is assigned to the association.
|
AssociationVersionInfo.Builder |
createdDate(Instant createdDate)
The date the association version was created.
|
AssociationVersionInfo.Builder |
documentVersion(String documentVersion)
The version of a Systems Manager document used when the association version was created.
|
AssociationVersionInfo.Builder |
maxConcurrency(String maxConcurrency)
The maximum number of targets allowed to run the association at the same time.
|
AssociationVersionInfo.Builder |
maxErrors(String maxErrors)
The number of errors that are allowed before the system stops sending requests to run the association on
additional targets.
|
AssociationVersionInfo.Builder |
name(String name)
The name specified when the association was created.
|
default AssociationVersionInfo.Builder |
outputLocation(Consumer<InstanceAssociationOutputLocation.Builder> outputLocation)
The location in Amazon S3 specified for the association when the association version was created.
|
AssociationVersionInfo.Builder |
outputLocation(InstanceAssociationOutputLocation outputLocation)
The location in Amazon S3 specified for the association when the association version was created.
|
AssociationVersionInfo.Builder |
parameters(Map<String,? extends Collection<String>> parameters)
Parameters specified when the association version was created.
|
AssociationVersionInfo.Builder |
scheduleExpression(String scheduleExpression)
The cron or rate schedule specified for the association when the association version was created.
|
AssociationVersionInfo.Builder |
syncCompliance(AssociationSyncCompliance syncCompliance)
The mode for generating association compliance.
|
AssociationVersionInfo.Builder |
syncCompliance(String syncCompliance)
The mode for generating association compliance.
|
AssociationVersionInfo.Builder |
targetLocations(Collection<TargetLocation> targetLocations)
The combination of AWS Regions and AWS accounts where you wanted to run the association when this association
version was created.
|
AssociationVersionInfo.Builder |
targetLocations(Consumer<TargetLocation.Builder>... targetLocations)
The combination of AWS Regions and AWS accounts where you wanted to run the association when this association
version was created.
|
AssociationVersionInfo.Builder |
targetLocations(TargetLocation... targetLocations)
The combination of AWS Regions and AWS accounts where you wanted to run the association when this association
version was created.
|
AssociationVersionInfo.Builder |
targets(Collection<Target> targets)
The targets specified for the association when the association version was created.
|
AssociationVersionInfo.Builder |
targets(Consumer<Target.Builder>... targets)
The targets specified for the association when the association version was created.
|
AssociationVersionInfo.Builder |
targets(Target... targets)
The targets specified for the association when the association version was created.
|
equalsBySdkFields, sdkFields
copy
applyMutation, build
AssociationVersionInfo.Builder associationId(String associationId)
The ID created by the system when the association was created.
associationId
- The ID created by the system when the association was created.AssociationVersionInfo.Builder associationVersion(String associationVersion)
The association version.
associationVersion
- The association version.AssociationVersionInfo.Builder createdDate(Instant createdDate)
The date the association version was created.
createdDate
- The date the association version was created.AssociationVersionInfo.Builder name(String name)
The name specified when the association was created.
name
- The name specified when the association was created.AssociationVersionInfo.Builder documentVersion(String documentVersion)
The version of a Systems Manager document used when the association version was created.
documentVersion
- The version of a Systems Manager document used when the association version was created.AssociationVersionInfo.Builder parameters(Map<String,? extends Collection<String>> parameters)
Parameters specified when the association version was created.
parameters
- Parameters specified when the association version was created.AssociationVersionInfo.Builder targets(Collection<Target> targets)
The targets specified for the association when the association version was created.
targets
- The targets specified for the association when the association version was created.AssociationVersionInfo.Builder targets(Target... targets)
The targets specified for the association when the association version was created.
targets
- The targets specified for the association when the association version was created.AssociationVersionInfo.Builder targets(Consumer<Target.Builder>... targets)
The targets specified for the association when the association version was created.
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)
AssociationVersionInfo.Builder scheduleExpression(String scheduleExpression)
The cron or rate schedule specified for the association when the association version was created.
scheduleExpression
- The cron or rate schedule specified for the association when the association version was created.AssociationVersionInfo.Builder outputLocation(InstanceAssociationOutputLocation outputLocation)
The location in Amazon S3 specified for the association when the association version was created.
outputLocation
- The location in Amazon S3 specified for the association when the association version was created.default AssociationVersionInfo.Builder outputLocation(Consumer<InstanceAssociationOutputLocation.Builder> outputLocation)
The location in Amazon S3 specified for the association when the association version was created.
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)
AssociationVersionInfo.Builder associationName(String associationName)
The name specified for the association version when the association version was created.
associationName
- The name specified for the association version when the association version was created.AssociationVersionInfo.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.
AssociationVersionInfo.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.
AssociationVersionInfo.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
AssociationVersionInfo.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
AssociationVersionInfo.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
AssociationVersionInfo.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
AssociationVersionInfo.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.AssociationVersionInfo.Builder targetLocations(Collection<TargetLocation> targetLocations)
The combination of AWS Regions and AWS accounts where you wanted to run the association when this association version was created.
targetLocations
- The combination of AWS Regions and AWS accounts where you wanted to run the association when this
association version was created.AssociationVersionInfo.Builder targetLocations(TargetLocation... targetLocations)
The combination of AWS Regions and AWS accounts where you wanted to run the association when this association version was created.
targetLocations
- The combination of AWS Regions and AWS accounts where you wanted to run the association when this
association version was created.AssociationVersionInfo.Builder targetLocations(Consumer<TargetLocation.Builder>... targetLocations)
The combination of AWS Regions and AWS accounts where you wanted to run the association when this association version was created.
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.