Interface AssociationVersionInfo.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AssociationVersionInfo.Builder,
,AssociationVersionInfo> SdkBuilder<AssociationVersionInfo.Builder,
,AssociationVersionInfo> SdkPojo
- Enclosing class:
AssociationVersionInfo
-
Method Summary
Modifier and TypeMethodDescriptionapplyOnlyAtCronInterval
(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.associationId
(String associationId) The ID created by the system when the association was created.associationName
(String associationName) The name specified for the association version when the association version was created.associationVersion
(String associationVersion) The association version.calendarNames
(String... calendarNames) The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.calendarNames
(Collection<String> calendarNames) The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.complianceSeverity
(String complianceSeverity) The severity level that is assigned to the association.complianceSeverity
(AssociationComplianceSeverity complianceSeverity) The severity level that is assigned to the association.createdDate
(Instant createdDate) The date the association version was created.documentVersion
(String documentVersion) The version of an Amazon Web Services Systems Manager document (SSM document) used when the association version was created.The number of hours that an association can run on specified targets.maxConcurrency
(String maxConcurrency) The maximum number of targets allowed to run the association at the same time.The number of errors that are allowed before the system stops sending requests to run the association on additional targets.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.outputLocation
(InstanceAssociationOutputLocation outputLocation) The location in Amazon S3 specified for the association when the association version was created.parameters
(Map<String, ? extends Collection<String>> parameters) Parameters specified when the association version was created.scheduleExpression
(String scheduleExpression) The cron or rate schedule specified for the association when the association version was created.scheduleOffset
(Integer scheduleOffset) Number of days to wait after the scheduled day to run an association.syncCompliance
(String syncCompliance) The mode for generating association compliance.syncCompliance
(AssociationSyncCompliance syncCompliance) The mode for generating association compliance.targetLocations
(Collection<TargetLocation> targetLocations) The combination of Amazon Web Services Regions and Amazon Web Services accounts where you wanted to run the association when this association version was created.targetLocations
(Consumer<TargetLocation.Builder>... targetLocations) The combination of Amazon Web Services Regions and Amazon Web Services accounts where you wanted to run the association when this association version was created.targetLocations
(TargetLocation... targetLocations) The combination of Amazon Web Services Regions and Amazon Web Services accounts where you wanted to run the association when this association version was created.targetMaps
(Collection<? extends Map<String, ? extends Collection<String>>> targetMaps) A key-value mapping of document parameters to target resources.targetMaps
(Map<String, ? extends Collection<String>>... targetMaps) A key-value mapping of document parameters to target resources.targets
(Collection<Target> targets) The targets specified for the association when the association version was created.targets
(Consumer<Target.Builder>... targets) The targets specified for the association when the association version was created.The targets specified for the association when the association version was created.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 Details
-
associationId
The ID created by the system when the association was created.
- Parameters:
associationId
- The ID created by the system when the association was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
associationVersion
The association version.
- Parameters:
associationVersion
- The association version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdDate
The date the association version was created.
- Parameters:
createdDate
- The date the association version was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
The name specified when the association was created.
- Parameters:
name
- The name specified when the association was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
documentVersion
The version of an Amazon Web Services Systems Manager document (SSM document) used when the association version was created.
- Parameters:
documentVersion
- The version of an Amazon Web Services Systems Manager document (SSM document) used when the association version was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameters
Parameters specified when the association version was created.
- Parameters:
parameters
- Parameters specified when the association version was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targets
The targets specified for the association when the association version was created.
- Parameters:
targets
- The targets specified for the association when the association version was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targets
The targets specified for the association when the association version was created.
- Parameters:
targets
- The targets specified for the association when the association version was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targets
The targets specified for the association when the association version was created.
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 totargets(List<Target>)
.- 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:
-
scheduleExpression
The cron or rate schedule specified for the association when the association version was created.
- Parameters:
scheduleExpression
- The cron or rate schedule specified for the association when the association version was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputLocation
The location in Amazon S3 specified for the association when the association version was created.
- Parameters:
outputLocation
- The location in Amazon S3 specified for the association when the association version was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputLocation
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 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:
-
associationName
The name specified for the association version when the association version was created.
- Parameters:
associationName
- The name specified for the association version when the association version was created.- 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, 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
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
The severity level that is assigned to the association.
- Parameters:
complianceSeverity
- The severity level that is assigned to the association.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
complianceSeverity
The severity level that is assigned to the association.
- Parameters:
complianceSeverity
- The severity level that is assigned to the association.- 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
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:
-
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:
-
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
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations for this version 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 for this version 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
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations for this version 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 for this version 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
The combination of Amazon Web Services Regions and Amazon Web Services accounts where you wanted to run the association when this association version was created.
- Parameters:
targetLocations
- The combination of Amazon Web Services Regions and Amazon Web Services accounts where you wanted to run the association when this association version was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetLocations
The combination of Amazon Web Services Regions and Amazon Web Services accounts where you wanted to run the association when this association version was created.
- Parameters:
targetLocations
- The combination of Amazon Web Services Regions and Amazon Web Services accounts where you wanted to run the association when this association version was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetLocations
The combination of Amazon Web Services Regions and Amazon Web Services accounts where you wanted to run the association when this association version was created.
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 totargetLocations(List<TargetLocation>)
.- 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:
-
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.
-
duration
The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.
- Parameters:
duration
- The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetMaps
AssociationVersionInfo.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
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.
-