Interface Association.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Association.Builder,
,Association> SdkBuilder<Association.Builder,
,Association> SdkPojo
- Enclosing class:
Association
-
Method Summary
Modifier and TypeMethodDescriptionassociationId
(String associationId) The ID created by the system when you create an association.associationName
(String associationName) The association name.associationVersion
(String associationVersion) The association version.documentVersion
(String documentVersion) The version of the document used in the association.The number of hours that an association can run on specified targets.instanceId
(String instanceId) The managed node ID.lastExecutionDate
(Instant lastExecutionDate) The date on which the association was last run.The name of the SSM document.default Association.Builder
overview
(Consumer<AssociationOverview.Builder> overview) Information about the association.overview
(AssociationOverview overview) Information about the association.scheduleExpression
(String scheduleExpression) A cron expression that specifies a schedule when the association runs.scheduleOffset
(Integer scheduleOffset) Number of days to wait after the scheduled day to run an association.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 managed nodes targeted by the request to create an association.targets
(Consumer<Target.Builder>... targets) The managed nodes targeted by the request to create an association.The managed nodes targeted by the request to create an association.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
-
name
The name of the SSM document.
- Parameters:
name
- The name of the SSM document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceId
The managed node ID.
- Parameters:
instanceId
- The managed node ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
associationId
The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.
- Parameters:
associationId
- The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.- 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.
-
documentVersion
The version of the document used in the association. If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the
apply-only-at-cron-interval
parameter.State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the
default
version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version todefault
.- Parameters:
documentVersion
- The version of the document used in the association. If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed theapply-only-at-cron-interval
parameter.State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the
default
version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version todefault
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targets
The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the
InstanceIds
key with a value of*
.- Parameters:
targets
- The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying theInstanceIds
key with a value of*
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targets
The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the
InstanceIds
key with a value of*
.- Parameters:
targets
- The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying theInstanceIds
key with a value of*
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targets
The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the
This is a convenience method that creates an instance of theInstanceIds
key with a value of*
.Target.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:
-
lastExecutionDate
The date on which the association was last run.
- Parameters:
lastExecutionDate
- The date on which the association was last run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overview
Information about the association.
- Parameters:
overview
- Information about the association.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overview
Information about the association.
This is a convenience method that creates an instance of theAssociationOverview.Builder
avoiding the need to create one manually viaAssociationOverview.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooverview(AssociationOverview)
.- Parameters:
overview
- a consumer that will call methods onAssociationOverview.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
scheduleExpression
A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).
- Parameters:
scheduleExpression
- A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
associationName
The association name.
- Parameters:
associationName
- The association name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
Association.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.
-