AssociationDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.simplesystemsmanagement.model.AssociationDescription

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AssociationDescription
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes the parameters for a document.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AssociationDescription()

Constructors
Constructor and Description
`AssociationDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
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)`
`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.
`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.
`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`	`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`	`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.
`String`	`toString()` Returns a string representation of this object.
`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`	`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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AssociationDescription
```
public AssociationDescription()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the SSM document.
    
    Parameters:
    
    name - The name of the SSM document.
  - getName
```
public String getName()
```
    The name of the SSM document.
    
    Returns:
    
    The name of the SSM document.
  - withName
```
public AssociationDescription withName(String 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.
  - setInstanceId
```
public void setInstanceId(String instanceId)
```
    The managed node ID.
    
    Parameters:
    
    instanceId - The managed node ID.
  - getInstanceId
```
public String getInstanceId()
```
    The managed node ID.
    
    Returns:
    
    The managed node ID.
  - withInstanceId
```
public AssociationDescription withInstanceId(String 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.
  - setAssociationVersion
```
public void setAssociationVersion(String associationVersion)
```
    The association version.
    
    Parameters:
    
    associationVersion - The association version.
  - getAssociationVersion
```
public String getAssociationVersion()
```
    The association version.
    
    Returns:
    
    The association version.
  - withAssociationVersion
```
public AssociationDescription withAssociationVersion(String associationVersion)
```
    The association version.
    
    Parameters:
    
    associationVersion - The association version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDate
```
public void setDate(Date date)
```
    The date when the association was made.
    
    Parameters:
    
    date - The date when the association was made.
  - getDate
```
public Date getDate()
```
    The date when the association was made.
    
    Returns:
    
    The date when the association was made.
  - withDate
```
public AssociationDescription withDate(Date date)
```
    The date when the association was made.
    
    Parameters:
    
    date - The date when the association was made.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdateAssociationDate
```
public void setLastUpdateAssociationDate(Date lastUpdateAssociationDate)
```
    The date when the association was last updated.
    
    Parameters:
    
    lastUpdateAssociationDate - The date when the association was last updated.
  - getLastUpdateAssociationDate
```
public Date getLastUpdateAssociationDate()
```
    The date when the association was last updated.
    
    Returns:
    
    The date when the association was last updated.
  - withLastUpdateAssociationDate
```
public AssociationDescription withLastUpdateAssociationDate(Date lastUpdateAssociationDate)
```
    The date when the association was last updated.
    
    Parameters:
    
    lastUpdateAssociationDate - The date when the association was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(AssociationStatus status)
```
    The association status.
    
    Parameters:
    
    status - The association status.
  - getStatus
```
public AssociationStatus getStatus()
```
    The association status.
    
    Returns:
    
    The association status.
  - withStatus
```
public AssociationDescription withStatus(AssociationStatus status)
```
    The association status.
    
    Parameters:
    
    status - The association status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOverview
```
public void setOverview(AssociationOverview overview)
```
    Information about the association.
    
    Parameters:
    
    overview - Information about the association.
  - getOverview
```
public AssociationOverview getOverview()
```
    Information about the association.
    
    Returns:
    
    Information about the association.
  - withOverview
```
public AssociationDescription withOverview(AssociationOverview 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.
  - setDocumentVersion
```
public void setDocumentVersion(String documentVersion)
```
    The document version.
    
    Parameters:
    
    documentVersion - The document version.
  - getDocumentVersion
```
public String getDocumentVersion()
```
    The document version.
    
    Returns:
    
    The document version.
  - withDocumentVersion
```
public AssociationDescription withDocumentVersion(String documentVersion)
```
    The document version.
    
    Parameters:
    
    documentVersion - The document version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAutomationTargetParameterName
```
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.
    
    Parameters:
    
    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.
  - getAutomationTargetParameterName
```
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.
    
    Returns:
    
    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.
  - withAutomationTargetParameterName
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getParameters
```
public Map<String,List<String>> getParameters()
```
    A description of the parameters for a document.
    
    Returns:
    
    A description of the parameters for a document.
  - setParameters
```
public void setParameters(Map<String,List<String>> parameters)
```
    A description of the parameters for a document.
    
    Parameters:
    
    parameters - A description of the parameters for a document.
  - withParameters
```
public AssociationDescription withParameters(Map<String,List<String>> parameters)
```
    A description of the parameters for a document.
    
    Parameters:
    
    parameters - A description of the parameters for a document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addParametersEntry
```
public AssociationDescription addParametersEntry(String key,
                                                 List<String> value)
```
    Add a single Parameters entry
    
    See Also:
    
    withParameters(java.util.Map<java.lang.String, java.util.List<java.lang.String>>)
  - clearParametersEntries
```
public AssociationDescription clearParametersEntries()
```
    Removes all the entries added into Parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAssociationId
```
public void setAssociationId(String associationId)
```
    The association ID.
    
    Parameters:
    
    associationId - The association ID.
  - getAssociationId
```
public String getAssociationId()
```
    The association ID.
    
    Returns:
    
    The association ID.
  - withAssociationId
```
public AssociationDescription withAssociationId(String associationId)
```
    The association ID.
    
    Parameters:
    
    associationId - The association ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTargets
```
public List<Target> getTargets()
```
    The managed nodes targeted by the request.
    
    Returns:
    
    The managed nodes targeted by the request.
  - setTargets
```
public void setTargets(Collection<Target> targets)
```
    The managed nodes targeted by the request.
    
    Parameters:
    
    targets - The managed nodes targeted by the request.
  - withTargets
```
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.
    
    Parameters:
    
    targets - The managed nodes targeted by the request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTargets
```
public AssociationDescription withTargets(Collection<Target> targets)
```
    The managed nodes targeted by the request.
    
    Parameters:
    
    targets - The managed nodes targeted by the request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setScheduleExpression
```
public void setScheduleExpression(String scheduleExpression)
```
    A cron expression that specifies a schedule when the association runs.
    
    Parameters:
    
    scheduleExpression - A cron expression that specifies a schedule when the association runs.
  - getScheduleExpression
```
public String getScheduleExpression()
```
    A cron expression that specifies a schedule when the association runs.
    
    Returns:
    
    A cron expression that specifies a schedule when the association runs.
  - withScheduleExpression
```
public AssociationDescription withScheduleExpression(String scheduleExpression)
```
    A cron expression that specifies a schedule when the association runs.
    
    Parameters:
    
    scheduleExpression - A cron expression that specifies a schedule when the association runs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputLocation
```
public void setOutputLocation(InstanceAssociationOutputLocation outputLocation)
```
    An S3 bucket where you want to store the output details of the request.
    
    Parameters:
    
    outputLocation - An S3 bucket where you want to store the output details of the request.
  - getOutputLocation
```
public InstanceAssociationOutputLocation getOutputLocation()
```
    An S3 bucket where you want to store the output details of the request.
    
    Returns:
    
    An S3 bucket where you want to store the output details of the request.
  - withOutputLocation
```
public AssociationDescription withOutputLocation(InstanceAssociationOutputLocation outputLocation)
```
    An S3 bucket where you want to store the output details of the request.
    
    Parameters:
    
    outputLocation - An S3 bucket where you want to store the output details of the request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastExecutionDate
```
public void setLastExecutionDate(Date lastExecutionDate)
```
    The date on which the association was last run.
    
    Parameters:
    
    lastExecutionDate - The date on which the association was last run.
  - getLastExecutionDate
```
public Date getLastExecutionDate()
```
    The date on which the association was last run.
    
    Returns:
    
    The date on which the association was last run.
  - withLastExecutionDate
```
public AssociationDescription withLastExecutionDate(Date 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.
  - setLastSuccessfulExecutionDate
```
public void setLastSuccessfulExecutionDate(Date lastSuccessfulExecutionDate)
```
    The last date on which the association was successfully run.
    
    Parameters:
    
    lastSuccessfulExecutionDate - The last date on which the association was successfully run.
  - getLastSuccessfulExecutionDate
```
public Date getLastSuccessfulExecutionDate()
```
    The last date on which the association was successfully run.
    
    Returns:
    
    The last date on which the association was successfully run.
  - withLastSuccessfulExecutionDate
```
public AssociationDescription withLastSuccessfulExecutionDate(Date lastSuccessfulExecutionDate)
```
    The last date on which the association was successfully run.
    
    Parameters:
    
    lastSuccessfulExecutionDate - The last date on which the association was successfully run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAssociationName
```
public void setAssociationName(String associationName)
```
    The association name.
    
    Parameters:
    
    associationName - The association name.
  - getAssociationName
```
public String getAssociationName()
```
    The association name.
    
    Returns:
    
    The association name.
  - withAssociationName
```
public AssociationDescription withAssociationName(String associationName)
```
    The association name.
    
    Parameters:
    
    associationName - The association name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxErrors
```
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.
    
    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 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.
  - getMaxErrors
```
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.
    
    Returns:
    
    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.
  - withMaxErrors
```
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.
    
    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 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxConcurrency
```
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.
    
    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 for MaxConcurrency.
  - getMaxConcurrency
```
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.
    
    Returns:
    
    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.
  - withMaxConcurrency
```
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.
    
    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 for MaxConcurrency.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setComplianceSeverity
```
public void setComplianceSeverity(String complianceSeverity)
```
    The severity level that is assigned to the association.
    
    Parameters:
    
    complianceSeverity - The severity level that is assigned to the association.
    
    See Also:
    
    AssociationComplianceSeverity
  - getComplianceSeverity
```
public String getComplianceSeverity()
```
    The severity level that is assigned to the association.
    
    Returns:
    
    The severity level that is assigned to the association.
    
    See Also:
    
    AssociationComplianceSeverity
  - withComplianceSeverity
```
public AssociationDescription withComplianceSeverity(String 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:
    
    AssociationComplianceSeverity
  - withComplianceSeverity
```
public AssociationDescription withComplianceSeverity(AssociationComplianceSeverity 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:
    
    AssociationComplianceSeverity
  - setSyncCompliance
```
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.
    
    Parameters:
    
    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.
    
    See Also:
    
    AssociationSyncCompliance
  - getSyncCompliance
```
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.
    
    Returns:
    
    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.
    
    See Also:
    
    AssociationSyncCompliance
  - withSyncCompliance
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AssociationSyncCompliance
  - withSyncCompliance
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AssociationSyncCompliance
  - setApplyOnlyAtCronInterval
```
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.
    
    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.
  - getApplyOnlyAtCronInterval
```
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.
    
    Returns:
    
    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.
  - withApplyOnlyAtCronInterval
```
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.
    
    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.
  - isApplyOnlyAtCronInterval
```
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.
    
    Returns:
    
    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.
  - getCalendarNames
```
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.
    
    Returns:
    
    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.
  - setCalendarNames
```
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.
    
    Parameters:
    
    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.
  - withCalendarNames
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCalendarNames
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTargetLocations
```
public List<TargetLocation> getTargetLocations()
```
    The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.
    
    Returns:
    
    The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.
  - setTargetLocations
```
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.
    
    Parameters:
    
    targetLocations - The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.
  - withTargetLocations
```
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.
    
    Parameters:
    
    targetLocations - The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTargetLocations
```
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.
    
    Parameters:
    
    targetLocations - The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setScheduleOffset
```
public void setScheduleOffset(Integer 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.
  - getScheduleOffset
```
public Integer getScheduleOffset()
```
    Number of days to wait after the scheduled day to run an association.
    
    Returns:
    
    Number of days to wait after the scheduled day to run an association.
  - withScheduleOffset
```
public AssociationDescription withScheduleOffset(Integer 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.
  - getTargetMaps
```
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.
    
    Returns:
    
    A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
  - setTargetMaps
```
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.
    
    Parameters:
    
    targetMaps - A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
  - withTargetMaps
```
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.
    
    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.
  - withTargetMaps
```
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.
    
    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.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AssociationDescription clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class AssociationDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AssociationDescription

Method Detail

setName

getName

withName

setInstanceId

getInstanceId

withInstanceId

setAssociationVersion

getAssociationVersion

withAssociationVersion

setDate

getDate

withDate

setLastUpdateAssociationDate

getLastUpdateAssociationDate

withLastUpdateAssociationDate

setStatus

getStatus

withStatus

setOverview

getOverview

withOverview

setDocumentVersion

getDocumentVersion

withDocumentVersion

setAutomationTargetParameterName

getAutomationTargetParameterName

withAutomationTargetParameterName

getParameters

setParameters

withParameters

addParametersEntry

clearParametersEntries

setAssociationId

getAssociationId

withAssociationId

getTargets

setTargets

withTargets

withTargets

setScheduleExpression

getScheduleExpression

withScheduleExpression

setOutputLocation

getOutputLocation

withOutputLocation

setLastExecutionDate

getLastExecutionDate

withLastExecutionDate

setLastSuccessfulExecutionDate

getLastSuccessfulExecutionDate

withLastSuccessfulExecutionDate

setAssociationName

getAssociationName

withAssociationName

setMaxErrors

getMaxErrors

withMaxErrors

setMaxConcurrency

getMaxConcurrency

withMaxConcurrency

setComplianceSeverity

getComplianceSeverity

withComplianceSeverity

withComplianceSeverity

setSyncCompliance

getSyncCompliance

withSyncCompliance

withSyncCompliance

setApplyOnlyAtCronInterval

getApplyOnlyAtCronInterval

withApplyOnlyAtCronInterval

isApplyOnlyAtCronInterval