@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AssociationDescription extends Object implements Serializable, Cloneable, StructuredPojo
Describes the parameters for a document.
Constructor and Description |
---|
AssociationDescription() |
Modifier and Type | Method and Description |
---|---|
AssociationDescription |
addParametersEntry(String key,
List<String> value)
Add a single Parameters entry
|
AssociationDescription |
clearParametersEntries()
Removes all the entries added into Parameters.
|
AssociationDescription |
clone() |
boolean |
equals(Object obj) |
AlarmConfiguration |
getAlarmConfiguration() |
Boolean |
getApplyOnlyAtCronInterval()
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.
|
String |
getAssociationId()
The association ID.
|
String |
getAssociationName()
The association name.
|
String |
getAssociationVersion()
The association version.
|
String |
getAutomationTargetParameterName()
Choose the parameter that will define how your automation will branch out.
|
List<String> |
getCalendarNames()
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated
under.
|
String |
getComplianceSeverity()
The severity level that is assigned to the association.
|
Date |
getDate()
The date when the association was made.
|
String |
getDocumentVersion()
The document version.
|
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.
|
Date |
getLastSuccessfulExecutionDate()
The last date on which the association was successfully run.
|
Date |
getLastUpdateAssociationDate()
The date when the association was last updated.
|
String |
getMaxConcurrency()
The maximum number of targets allowed to run the association at the same time.
|
String |
getMaxErrors()
The number of errors that are allowed before the system stops sending requests to run the association on
additional targets.
|
String |
getName()
The name of the SSM document.
|
InstanceAssociationOutputLocation |
getOutputLocation()
An S3 bucket where you want to store the output details of the request.
|
AssociationOverview |
getOverview()
Information about the association.
|
Map<String,List<String>> |
getParameters()
A description of the parameters for a document.
|
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.
|
AssociationStatus |
getStatus()
The association status.
|
String |
getSyncCompliance()
The mode for generating association compliance.
|
List<TargetLocation> |
getTargetLocations()
The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the
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.
|
List<AlarmStateInformation> |
getTriggeredAlarms()
The CloudWatch alarm that was invoked during the association.
|
int |
hashCode() |
Boolean |
isApplyOnlyAtCronInterval()
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.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAlarmConfiguration(AlarmConfiguration alarmConfiguration) |
void |
setApplyOnlyAtCronInterval(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.
|
void |
setAssociationId(String associationId)
The association ID.
|
void |
setAssociationName(String associationName)
The association name.
|
void |
setAssociationVersion(String associationVersion)
The association version.
|
void |
setAutomationTargetParameterName(String automationTargetParameterName)
Choose the parameter that will define how your automation will branch out.
|
void |
setCalendarNames(Collection<String> calendarNames)
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated
under.
|
void |
setComplianceSeverity(String complianceSeverity)
The severity level that is assigned to the association.
|
void |
setDate(Date date)
The date when the association was made.
|
void |
setDocumentVersion(String documentVersion)
The document version.
|
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 |
setLastSuccessfulExecutionDate(Date lastSuccessfulExecutionDate)
The last date on which the association was successfully run.
|
void |
setLastUpdateAssociationDate(Date lastUpdateAssociationDate)
The date when the association was last updated.
|
void |
setMaxConcurrency(String maxConcurrency)
The maximum number of targets allowed to run the association at the same time.
|
void |
setMaxErrors(String maxErrors)
The number of errors that are allowed before the system stops sending requests to run the association on
additional targets.
|
void |
setName(String name)
The name of the SSM document.
|
void |
setOutputLocation(InstanceAssociationOutputLocation outputLocation)
An S3 bucket where you want to store the output details of the request.
|
void |
setOverview(AssociationOverview overview)
Information about the association.
|
void |
setParameters(Map<String,List<String>> parameters)
A description of the parameters for a document.
|
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 |
setStatus(AssociationStatus status)
The association status.
|
void |
setSyncCompliance(String syncCompliance)
The mode for generating association compliance.
|
void |
setTargetLocations(Collection<TargetLocation> targetLocations)
The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the
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.
|
void |
setTriggeredAlarms(Collection<AlarmStateInformation> triggeredAlarms)
The CloudWatch alarm that was invoked during the association.
|
String |
toString()
Returns a string representation of this object.
|
AssociationDescription |
withAlarmConfiguration(AlarmConfiguration alarmConfiguration) |
AssociationDescription |
withApplyOnlyAtCronInterval(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 |
withAssociationId(String associationId)
The association ID.
|
AssociationDescription |
withAssociationName(String associationName)
The association name.
|
AssociationDescription |
withAssociationVersion(String associationVersion)
The association version.
|
AssociationDescription |
withAutomationTargetParameterName(String automationTargetParameterName)
Choose the parameter that will define how your automation will branch out.
|
AssociationDescription |
withCalendarNames(Collection<String> calendarNames)
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated
under.
|
AssociationDescription |
withCalendarNames(String... calendarNames)
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated
under.
|
AssociationDescription |
withComplianceSeverity(AssociationComplianceSeverity complianceSeverity)
The severity level that is assigned to the association.
|
AssociationDescription |
withComplianceSeverity(String complianceSeverity)
The severity level that is assigned to the association.
|
AssociationDescription |
withDate(Date date)
The date when the association was made.
|
AssociationDescription |
withDocumentVersion(String documentVersion)
The document version.
|
AssociationDescription |
withDuration(Integer duration)
The number of hours that an association can run on specified targets.
|
AssociationDescription |
withInstanceId(String instanceId)
The managed node ID.
|
AssociationDescription |
withLastExecutionDate(Date lastExecutionDate)
The date on which the association was last run.
|
AssociationDescription |
withLastSuccessfulExecutionDate(Date lastSuccessfulExecutionDate)
The last date on which the association was successfully run.
|
AssociationDescription |
withLastUpdateAssociationDate(Date lastUpdateAssociationDate)
The date when the association was last updated.
|
AssociationDescription |
withMaxConcurrency(String maxConcurrency)
The maximum number of targets allowed to run the association at the same time.
|
AssociationDescription |
withMaxErrors(String maxErrors)
The number of errors that are allowed before the system stops sending requests to run the association on
additional targets.
|
AssociationDescription |
withName(String name)
The name of the SSM document.
|
AssociationDescription |
withOutputLocation(InstanceAssociationOutputLocation outputLocation)
An S3 bucket where you want to store the output details of the request.
|
AssociationDescription |
withOverview(AssociationOverview overview)
Information about the association.
|
AssociationDescription |
withParameters(Map<String,List<String>> parameters)
A description of the parameters for a document.
|
AssociationDescription |
withScheduleExpression(String scheduleExpression)
A cron expression that specifies a schedule when the association runs.
|
AssociationDescription |
withScheduleOffset(Integer scheduleOffset)
Number of days to wait after the scheduled day to run an association.
|
AssociationDescription |
withStatus(AssociationStatus status)
The association status.
|
AssociationDescription |
withSyncCompliance(AssociationSyncCompliance syncCompliance)
The mode for generating association compliance.
|
AssociationDescription |
withSyncCompliance(String syncCompliance)
The mode for generating association compliance.
|
AssociationDescription |
withTargetLocations(Collection<TargetLocation> targetLocations)
The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the
association.
|
AssociationDescription |
withTargetLocations(TargetLocation... targetLocations)
The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the
association.
|
AssociationDescription |
withTargetMaps(Collection<Map<String,List<String>>> targetMaps)
A key-value mapping of document parameters to target resources.
|
AssociationDescription |
withTargetMaps(Map<String,List<String>>... targetMaps)
A key-value mapping of document parameters to target resources.
|
AssociationDescription |
withTargets(Collection<Target> targets)
The managed nodes targeted by the request.
|
AssociationDescription |
withTargets(Target... targets)
The managed nodes targeted by the request.
|
AssociationDescription |
withTriggeredAlarms(AlarmStateInformation... triggeredAlarms)
The CloudWatch alarm that was invoked during the association.
|
AssociationDescription |
withTriggeredAlarms(Collection<AlarmStateInformation> triggeredAlarms)
The CloudWatch alarm that was invoked during the 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 AssociationDescription 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 AssociationDescription withInstanceId(String instanceId)
The managed node ID.
instanceId
- The managed node ID.public void setAssociationVersion(String associationVersion)
The association version.
associationVersion
- The association version.public String getAssociationVersion()
The association version.
public AssociationDescription withAssociationVersion(String associationVersion)
The association version.
associationVersion
- The association version.public void setDate(Date date)
The date when the association was made.
date
- The date when the association was made.public Date getDate()
The date when the association was made.
public AssociationDescription withDate(Date date)
The date when the association was made.
date
- The date when the association was made.public void setLastUpdateAssociationDate(Date lastUpdateAssociationDate)
The date when the association was last updated.
lastUpdateAssociationDate
- The date when the association was last updated.public Date getLastUpdateAssociationDate()
The date when the association was last updated.
public AssociationDescription withLastUpdateAssociationDate(Date lastUpdateAssociationDate)
The date when the association was last updated.
lastUpdateAssociationDate
- The date when the association was last updated.public void setStatus(AssociationStatus status)
The association status.
status
- The association status.public AssociationStatus getStatus()
The association status.
public AssociationDescription withStatus(AssociationStatus status)
The association status.
status
- The association status.public void setOverview(AssociationOverview overview)
Information about the association.
overview
- Information about the association.public AssociationOverview getOverview()
Information about the association.
public AssociationDescription withOverview(AssociationOverview overview)
Information about the association.
overview
- Information about the association.public void setDocumentVersion(String documentVersion)
The document version.
documentVersion
- The document version.public String getDocumentVersion()
The document version.
public AssociationDescription withDocumentVersion(String documentVersion)
The document version.
documentVersion
- The document version.public void setAutomationTargetParameterName(String automationTargetParameterName)
Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
automationTargetParameterName
- Choose the parameter that will define how your automation will branch out. This target is required for
associations that use an Automation runbook and target resources by using rate controls. Automation is a
capability of Amazon Web Services Systems Manager.public String getAutomationTargetParameterName()
Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
public AssociationDescription withAutomationTargetParameterName(String automationTargetParameterName)
Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
automationTargetParameterName
- Choose the parameter that will define how your automation will branch out. This target is required for
associations that use an Automation runbook and target resources by using rate controls. Automation is a
capability of Amazon Web Services Systems Manager.public Map<String,List<String>> getParameters()
A description of the parameters for a document.
public void setParameters(Map<String,List<String>> parameters)
A description of the parameters for a document.
parameters
- A description of the parameters for a document.public AssociationDescription withParameters(Map<String,List<String>> parameters)
A description of the parameters for a document.
parameters
- A description of the parameters for a document.public AssociationDescription addParametersEntry(String key, List<String> value)
public AssociationDescription clearParametersEntries()
public void setAssociationId(String associationId)
The association ID.
associationId
- The association ID.public String getAssociationId()
The association ID.
public AssociationDescription withAssociationId(String associationId)
The association ID.
associationId
- The association ID.public List<Target> getTargets()
The managed nodes targeted by the request.
public void setTargets(Collection<Target> targets)
The managed nodes targeted by the request.
targets
- The managed nodes targeted by the request.public AssociationDescription withTargets(Target... targets)
The managed nodes targeted by the request.
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.public AssociationDescription withTargets(Collection<Target> targets)
The managed nodes targeted by the request.
targets
- The managed nodes targeted by the request.public void setScheduleExpression(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.public String getScheduleExpression()
A cron expression that specifies a schedule when the association runs.
public AssociationDescription withScheduleExpression(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.public void setOutputLocation(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.public InstanceAssociationOutputLocation getOutputLocation()
An S3 bucket where you want to store the output details of the request.
public AssociationDescription withOutputLocation(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.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 AssociationDescription withLastExecutionDate(Date lastExecutionDate)
The date on which the association was last run.
lastExecutionDate
- The date on which the association was last run.public void setLastSuccessfulExecutionDate(Date lastSuccessfulExecutionDate)
The last date on which the association was successfully run.
lastSuccessfulExecutionDate
- The last date on which the association was successfully run.public Date getLastSuccessfulExecutionDate()
The last date on which the association was successfully run.
public AssociationDescription withLastSuccessfulExecutionDate(Date lastSuccessfulExecutionDate)
The last date on which the association was successfully run.
lastSuccessfulExecutionDate
- The last date on which the association was successfully run.public void setAssociationName(String associationName)
The association name.
associationName
- The association name.public String getAssociationName()
The association name.
public AssociationDescription withAssociationName(String associationName)
The association name.
associationName
- The association name.public void setMaxErrors(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 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, 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 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, set MaxConcurrency
to 1 so that executions proceed one at
a time.
public String getMaxErrors()
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, set MaxConcurrency
to 1 so that executions proceed one at a time.
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.
public AssociationDescription withMaxErrors(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 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, 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 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, set MaxConcurrency
to 1 so that executions proceed one at
a time.
public void setMaxConcurrency(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 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 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 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 for
MaxConcurrency
.
public String getMaxConcurrency()
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 for
MaxConcurrency
.
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 for
MaxConcurrency
.
public AssociationDescription withMaxConcurrency(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 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 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 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 for
MaxConcurrency
.
public void setComplianceSeverity(String complianceSeverity)
The severity level that is assigned to the association.
complianceSeverity
- The severity level that is assigned to the association.AssociationComplianceSeverity
public String getComplianceSeverity()
The severity level that is assigned to the association.
AssociationComplianceSeverity
public AssociationDescription withComplianceSeverity(String complianceSeverity)
The severity level that is assigned to the association.
complianceSeverity
- The severity level that is assigned to the association.AssociationComplianceSeverity
public AssociationDescription withComplianceSeverity(AssociationComplianceSeverity complianceSeverity)
The severity level that is assigned to the association.
complianceSeverity
- The severity level that is assigned to the association.AssociationComplianceSeverity
public void setSyncCompliance(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 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.
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 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.
AssociationSyncCompliance
public String getSyncCompliance()
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 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.
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 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.
AssociationSyncCompliance
public AssociationDescription withSyncCompliance(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 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.
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 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.
AssociationSyncCompliance
public AssociationDescription withSyncCompliance(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 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.
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 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.
AssociationSyncCompliance
public void setApplyOnlyAtCronInterval(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 isn't 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 isn't supported for rate expressions.public Boolean getApplyOnlyAtCronInterval()
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.
public AssociationDescription withApplyOnlyAtCronInterval(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 isn't 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 isn't supported for rate expressions.public Boolean isApplyOnlyAtCronInterval()
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.
public List<String> getCalendarNames()
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
public void setCalendarNames(Collection<String> calendarNames)
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
calendarNames
- The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are
gated under. The associations only run when that change calendar is open. For more information, see Amazon
Web Services Systems Manager Change Calendar.public AssociationDescription withCalendarNames(String... calendarNames)
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
NOTE: This method appends the values to the existing list (if any). Use
setCalendarNames(java.util.Collection)
or withCalendarNames(java.util.Collection)
if you want
to override the existing values.
calendarNames
- The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are
gated under. The associations only run when that change calendar is open. For more information, see Amazon
Web Services Systems Manager Change Calendar.public AssociationDescription withCalendarNames(Collection<String> calendarNames)
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
calendarNames
- The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are
gated under. The associations only run when that change calendar is open. For more information, see Amazon
Web Services Systems Manager Change Calendar.public List<TargetLocation> getTargetLocations()
The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.
public void setTargetLocations(Collection<TargetLocation> targetLocations)
The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.
targetLocations
- The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the
association.public AssociationDescription withTargetLocations(TargetLocation... targetLocations)
The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.
NOTE: This method appends the values to the existing list (if any). Use
setTargetLocations(java.util.Collection)
or withTargetLocations(java.util.Collection)
if you
want to override the existing values.
targetLocations
- The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the
association.public AssociationDescription withTargetLocations(Collection<TargetLocation> targetLocations)
The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.
targetLocations
- The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the
association.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 AssociationDescription 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 AssociationDescription 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 AssociationDescription 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 AssociationDescription 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 void setAlarmConfiguration(AlarmConfiguration alarmConfiguration)
alarmConfiguration
- public AlarmConfiguration getAlarmConfiguration()
public AssociationDescription withAlarmConfiguration(AlarmConfiguration alarmConfiguration)
alarmConfiguration
- public List<AlarmStateInformation> getTriggeredAlarms()
The CloudWatch alarm that was invoked during the association.
public void setTriggeredAlarms(Collection<AlarmStateInformation> triggeredAlarms)
The CloudWatch alarm that was invoked during the association.
triggeredAlarms
- The CloudWatch alarm that was invoked during the association.public AssociationDescription withTriggeredAlarms(AlarmStateInformation... triggeredAlarms)
The CloudWatch alarm that was invoked during the association.
NOTE: This method appends the values to the existing list (if any). Use
setTriggeredAlarms(java.util.Collection)
or withTriggeredAlarms(java.util.Collection)
if you
want to override the existing values.
triggeredAlarms
- The CloudWatch alarm that was invoked during the association.public AssociationDescription withTriggeredAlarms(Collection<AlarmStateInformation> triggeredAlarms)
The CloudWatch alarm that was invoked during the association.
triggeredAlarms
- The CloudWatch alarm that was invoked during the association.public String toString()
toString
in class Object
Object.toString()
public AssociationDescription clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.