@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Association extends Object implements Serializable, Cloneable, StructuredPojo
Describes an association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.
Constructor and Description |
---|
Association() |
Modifier and Type | Method and Description |
---|---|
Association |
clone() |
boolean |
equals(Object obj) |
String |
getAssociationId()
The ID created by the system when you create an association.
|
String |
getAssociationName()
The association name.
|
String |
getAssociationVersion()
The association version.
|
String |
getDocumentVersion()
The version of the document used in the association.
|
Integer |
getDuration()
The number of hours that an association can run on specified targets.
|
String |
getInstanceId()
The managed node ID.
|
Date |
getLastExecutionDate()
The date on which the association was last run.
|
String |
getName()
The name of the SSM document.
|
AssociationOverview |
getOverview()
Information about the association.
|
String |
getScheduleExpression()
A cron expression that specifies a schedule when the association runs.
|
Integer |
getScheduleOffset()
Number of days to wait after the scheduled day to run an association.
|
List<Map<String,List<String>>> |
getTargetMaps()
A key-value mapping of document parameters to target resources.
|
List<Target> |
getTargets()
The managed nodes targeted by the request to create an association.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAssociationId(String associationId)
The ID created by the system when you create an association.
|
void |
setAssociationName(String associationName)
The association name.
|
void |
setAssociationVersion(String associationVersion)
The association version.
|
void |
setDocumentVersion(String documentVersion)
The version of the document used in the association.
|
void |
setDuration(Integer duration)
The number of hours that an association can run on specified targets.
|
void |
setInstanceId(String instanceId)
The managed node ID.
|
void |
setLastExecutionDate(Date lastExecutionDate)
The date on which the association was last run.
|
void |
setName(String name)
The name of the SSM document.
|
void |
setOverview(AssociationOverview overview)
Information about the association.
|
void |
setScheduleExpression(String scheduleExpression)
A cron expression that specifies a schedule when the association runs.
|
void |
setScheduleOffset(Integer scheduleOffset)
Number of days to wait after the scheduled day to run an association.
|
void |
setTargetMaps(Collection<Map<String,List<String>>> targetMaps)
A key-value mapping of document parameters to target resources.
|
void |
setTargets(Collection<Target> targets)
The managed nodes targeted by the request to create an association.
|
String |
toString()
Returns a string representation of this object.
|
Association |
withAssociationId(String associationId)
The ID created by the system when you create an association.
|
Association |
withAssociationName(String associationName)
The association name.
|
Association |
withAssociationVersion(String associationVersion)
The association version.
|
Association |
withDocumentVersion(String documentVersion)
The version of the document used in the association.
|
Association |
withDuration(Integer duration)
The number of hours that an association can run on specified targets.
|
Association |
withInstanceId(String instanceId)
The managed node ID.
|
Association |
withLastExecutionDate(Date lastExecutionDate)
The date on which the association was last run.
|
Association |
withName(String name)
The name of the SSM document.
|
Association |
withOverview(AssociationOverview overview)
Information about the association.
|
Association |
withScheduleExpression(String scheduleExpression)
A cron expression that specifies a schedule when the association runs.
|
Association |
withScheduleOffset(Integer scheduleOffset)
Number of days to wait after the scheduled day to run an association.
|
Association |
withTargetMaps(Collection<Map<String,List<String>>> targetMaps)
A key-value mapping of document parameters to target resources.
|
Association |
withTargetMaps(Map<String,List<String>>... targetMaps)
A key-value mapping of document parameters to target resources.
|
Association |
withTargets(Collection<Target> targets)
The managed nodes targeted by the request to create an association.
|
Association |
withTargets(Target... targets)
The managed nodes targeted by the request to create an association.
|
public void setName(String name)
The name of the SSM document.
name
- The name of the SSM document.public String getName()
The name of the SSM document.
public Association withName(String name)
The name of the SSM document.
name
- The name of the SSM document.public void setInstanceId(String instanceId)
The managed node ID.
instanceId
- The managed node ID.public String getInstanceId()
The managed node ID.
public Association withInstanceId(String instanceId)
The managed node ID.
instanceId
- The managed node ID.public void setAssociationId(String 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.
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.public String getAssociationId()
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.
public Association withAssociationId(String 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.
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.public void setAssociationVersion(String associationVersion)
The association version.
associationVersion
- The association version.public String getAssociationVersion()
The association version.
public Association withAssociationVersion(String associationVersion)
The association version.
associationVersion
- The association version.public void setDocumentVersion(String 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 to default
.
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 to default
.
public String getDocumentVersion()
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 to default
.
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 to default
.
public Association withDocumentVersion(String 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 to default
.
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 to default
.
public List<Target> getTargets()
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 *
.
InstanceIds
key with a value of
*
.public void setTargets(Collection<Target> 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 *
.
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 *
.public Association withTargets(Target... 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 *
.
NOTE: This method appends the values to the existing list (if any). Use
setTargets(java.util.Collection)
or withTargets(java.util.Collection)
if you want to override
the existing values.
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 *
.public Association withTargets(Collection<Target> 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 *
.
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 *
.public void setLastExecutionDate(Date lastExecutionDate)
The date on which the association was last run.
lastExecutionDate
- The date on which the association was last run.public Date getLastExecutionDate()
The date on which the association was last run.
public Association withLastExecutionDate(Date lastExecutionDate)
The date on which the association was last run.
lastExecutionDate
- The date on which the association was last run.public void setOverview(AssociationOverview overview)
Information about the association.
overview
- Information about the association.public AssociationOverview getOverview()
Information about the association.
public Association withOverview(AssociationOverview overview)
Information about the association.
overview
- Information about the association.public void setScheduleExpression(String scheduleExpression)
A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).
scheduleExpression
- A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated
Universal Time (UTC).public String getScheduleExpression()
A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).
public Association withScheduleExpression(String scheduleExpression)
A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).
scheduleExpression
- A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated
Universal Time (UTC).public void setAssociationName(String associationName)
The association name.
associationName
- The association name.public String getAssociationName()
The association name.
public Association withAssociationName(String associationName)
The association name.
associationName
- The association name.public void setScheduleOffset(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.public Integer getScheduleOffset()
Number of days to wait after the scheduled day to run an association.
public Association withScheduleOffset(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.public void setDuration(Integer 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.
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.public Integer getDuration()
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.
public Association withDuration(Integer 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.
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.public List<Map<String,List<String>>> getTargetMaps()
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
public void setTargetMaps(Collection<Map<String,List<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.public Association withTargetMaps(Map<String,List<String>>... targetMaps)
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
NOTE: This method appends the values to the existing list (if any). Use
setTargetMaps(java.util.Collection)
or withTargetMaps(java.util.Collection)
if you want to
override the existing values.
targetMaps
- A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be
specified together.public Association withTargetMaps(Collection<Map<String,List<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.public String toString()
toString
in class Object
Object.toString()
public Association clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.