CreateAssociationBatchRequestEntry (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateAssociationBatchRequestEntry
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes the association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateAssociationBatchRequestEntry()

Constructors
Constructor and Description
`CreateAssociationBatchRequestEntry()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateAssociationBatchRequestEntry`	`addParametersEntry(String key, List<String> value)` Add a single Parameters entry
`CreateAssociationBatchRequestEntry`	`clearParametersEntries()` Removes all the entries added into Parameters.
`CreateAssociationBatchRequestEntry`	`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`	`getAssociationName()` Specify a descriptive name for the association.
`String`	`getAutomationTargetParameterName()` Specify the target for the association.
`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 to assign to the association.
`String`	`getDocumentVersion()` The document version.
`String`	`getInstanceId()` The managed node ID.
`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 that contains the configuration information for the managed node.
`InstanceAssociationOutputLocation`	`getOutputLocation()` An S3 bucket where you want to store the results of this request.
`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.
`String`	`getSyncCompliance()` The mode for generating association compliance.
`List<TargetLocation>`	`getTargetLocations()` Use this action to create an association in multiple Regions and multiple accounts.
`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`	`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`	`setAssociationName(String associationName)` Specify a descriptive name for the association.
`void`	`setAutomationTargetParameterName(String automationTargetParameterName)` Specify the target for the association.
`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 to assign to the association.
`void`	`setDocumentVersion(String documentVersion)` The document version.
`void`	`setInstanceId(String instanceId)` The managed node ID.
`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 that contains the configuration information for the managed node.
`void`	`setOutputLocation(InstanceAssociationOutputLocation outputLocation)` An S3 bucket where you want to store the results of this request.
`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`	`setSyncCompliance(String syncCompliance)` The mode for generating association compliance.
`void`	`setTargetLocations(Collection<TargetLocation> targetLocations)` Use this action to create an association in multiple Regions and multiple accounts.
`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.
`CreateAssociationBatchRequestEntry`	`withAlarmConfiguration(AlarmConfiguration alarmConfiguration)`
`CreateAssociationBatchRequestEntry`	`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.
`CreateAssociationBatchRequestEntry`	`withAssociationName(String associationName)` Specify a descriptive name for the association.
`CreateAssociationBatchRequestEntry`	`withAutomationTargetParameterName(String automationTargetParameterName)` Specify the target for the association.
`CreateAssociationBatchRequestEntry`	`withCalendarNames(Collection<String> calendarNames)` The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.
`CreateAssociationBatchRequestEntry`	`withCalendarNames(String... calendarNames)` The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.
`CreateAssociationBatchRequestEntry`	`withComplianceSeverity(AssociationComplianceSeverity complianceSeverity)` The severity level to assign to the association.
`CreateAssociationBatchRequestEntry`	`withComplianceSeverity(String complianceSeverity)` The severity level to assign to the association.
`CreateAssociationBatchRequestEntry`	`withDocumentVersion(String documentVersion)` The document version.
`CreateAssociationBatchRequestEntry`	`withInstanceId(String instanceId)` The managed node ID.
`CreateAssociationBatchRequestEntry`	`withMaxConcurrency(String maxConcurrency)` The maximum number of targets allowed to run the association at the same time.
`CreateAssociationBatchRequestEntry`	`withMaxErrors(String maxErrors)` The number of errors that are allowed before the system stops sending requests to run the association on additional targets.
`CreateAssociationBatchRequestEntry`	`withName(String name)` The name of the SSM document that contains the configuration information for the managed node.
`CreateAssociationBatchRequestEntry`	`withOutputLocation(InstanceAssociationOutputLocation outputLocation)` An S3 bucket where you want to store the results of this request.
`CreateAssociationBatchRequestEntry`	`withParameters(Map<String,List<String>> parameters)` A description of the parameters for a document.
`CreateAssociationBatchRequestEntry`	`withScheduleExpression(String scheduleExpression)` A cron expression that specifies a schedule when the association runs.
`CreateAssociationBatchRequestEntry`	`withScheduleOffset(Integer scheduleOffset)` Number of days to wait after the scheduled day to run an association.
`CreateAssociationBatchRequestEntry`	`withSyncCompliance(AssociationSyncCompliance syncCompliance)` The mode for generating association compliance.
`CreateAssociationBatchRequestEntry`	`withSyncCompliance(String syncCompliance)` The mode for generating association compliance.
`CreateAssociationBatchRequestEntry`	`withTargetLocations(Collection<TargetLocation> targetLocations)` Use this action to create an association in multiple Regions and multiple accounts.
`CreateAssociationBatchRequestEntry`	`withTargetLocations(TargetLocation... targetLocations)` Use this action to create an association in multiple Regions and multiple accounts.
`CreateAssociationBatchRequestEntry`	`withTargetMaps(Collection<Map<String,List<String>>> targetMaps)` A key-value mapping of document parameters to target resources.
`CreateAssociationBatchRequestEntry`	`withTargetMaps(Map<String,List<String>>... targetMaps)` A key-value mapping of document parameters to target resources.
`CreateAssociationBatchRequestEntry`	`withTargets(Collection<Target> targets)` The managed nodes targeted by the request.
`CreateAssociationBatchRequestEntry`	`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
  - CreateAssociationBatchRequestEntry
```
public CreateAssociationBatchRequestEntry()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the SSM document that contains the configuration information for the managed node. You can specify Command or Automation runbooks.
    
    You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
    
    For SSM documents that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:
    
    arn:aws:ssm:region:account-id:document/document-name
    
    For example:
    
    arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
    
    For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.
    
    Parameters:
    
    name - The name of the SSM document that contains the configuration information for the managed node. You can specify Command or Automation runbooks.
    
    You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
    
    For SSM documents that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:
    
    arn:aws:ssm:region:account-id:document/document-name
    
    For example:
    
    arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
    
    For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.
  - getName
```
public String getName()
```
    The name of the SSM document that contains the configuration information for the managed node. You can specify Command or Automation runbooks.
    
    You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
    
    For SSM documents that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:
    
    arn:aws:ssm:region:account-id:document/document-name
    
    For example:
    
    arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
    
    For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.
    
    Returns:
    
    The name of the SSM document that contains the configuration information for the managed node. You can specify Command or Automation runbooks.
    
    You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
    
    For SSM documents that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:
    
    arn:aws:ssm:region:account-id:document/document-name
    
    For example:
    
    arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
    
    For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.
  - withName
```
public CreateAssociationBatchRequestEntry withName(String name)
```
    The name of the SSM document that contains the configuration information for the managed node. You can specify Command or Automation runbooks.
    
    You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
    
    For SSM documents that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:
    
    arn:aws:ssm:region:account-id:document/document-name
    
    For example:
    
    arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
    
    For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.
    
    Parameters:
    
    name - The name of the SSM document that contains the configuration information for the managed node. You can specify Command or Automation runbooks.
    
    You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
    
    For SSM documents that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:
    
    arn:aws:ssm:region:account-id:document/document-name
    
    For example:
    
    arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
    
    For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-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.
    
    InstanceId has been deprecated. To specify a managed node ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you can't use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.
    
    Parameters:
    
    instanceId - The managed node ID.
    
    InstanceId has been deprecated. To specify a managed node ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you can't use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.
  - getInstanceId
```
public String getInstanceId()
```
    The managed node ID.
    
    InstanceId has been deprecated. To specify a managed node ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you can't use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.
    
    Returns:
    
    The managed node ID.
    
    InstanceId has been deprecated. To specify a managed node ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you can't use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.
  - withInstanceId
```
public CreateAssociationBatchRequestEntry withInstanceId(String instanceId)
```
    The managed node ID.
    
    InstanceId has been deprecated. To specify a managed node ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you can't use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.
    
    Parameters:
    
    instanceId - The managed node ID.
    
    InstanceId has been deprecated. To specify a managed node ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you can't use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.
    
    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 CreateAssociationBatchRequestEntry 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 CreateAssociationBatchRequestEntry 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 CreateAssociationBatchRequestEntry clearParametersEntries()
```
    Removes all the entries added into Parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAutomationTargetParameterName
```
public void setAutomationTargetParameterName(String automationTargetParameterName)
```
    Specify the target for the association. 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 - Specify the target for the association. 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()
```
    Specify the target for the association. 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:
    
    Specify the target for the association. 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 CreateAssociationBatchRequestEntry withAutomationTargetParameterName(String automationTargetParameterName)
```
    Specify the target for the association. 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 - Specify the target for the association. 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.
  - 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 CreateAssociationBatchRequestEntry 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.
  - 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 CreateAssociationBatchRequestEntry 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 CreateAssociationBatchRequestEntry 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 CreateAssociationBatchRequestEntry 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 results of this request.
    
    Parameters:
    
    outputLocation - An S3 bucket where you want to store the results of this request.
  - getOutputLocation
```
public InstanceAssociationOutputLocation getOutputLocation()
```
    An S3 bucket where you want to store the results of this request.
    
    Returns:
    
    An S3 bucket where you want to store the results of this request.
  - withOutputLocation
```
public CreateAssociationBatchRequestEntry withOutputLocation(InstanceAssociationOutputLocation outputLocation)
```
    An S3 bucket where you want to store the results of this request.
    
    Parameters:
    
    outputLocation - An S3 bucket where you want to store the results of this request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAssociationName
```
public void setAssociationName(String associationName)
```
    Specify a descriptive name for the association.
    
    Parameters:
    
    associationName - Specify a descriptive name for the association.
  - getAssociationName
```
public String getAssociationName()
```
    Specify a descriptive name for the association.
    
    Returns:
    
    Specify a descriptive name for the association.
  - withAssociationName
```
public CreateAssociationBatchRequestEntry withAssociationName(String associationName)
```
    Specify a descriptive name for the association.
    
    Parameters:
    
    associationName - Specify a descriptive name for the association.
    
    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 CreateAssociationBatchRequestEntry 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 CreateAssociationBatchRequestEntry 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 to assign to the association.
    
    Parameters:
    
    complianceSeverity - The severity level to assign to the association.
    
    See Also:
    
    AssociationComplianceSeverity
  - getComplianceSeverity
```
public String getComplianceSeverity()
```
    The severity level to assign to the association.
    
    Returns:
    
    The severity level to assign to the association.
    
    See Also:
    
    AssociationComplianceSeverity
  - withComplianceSeverity
```
public CreateAssociationBatchRequestEntry withComplianceSeverity(String complianceSeverity)
```
    The severity level to assign to the association.
    
    Parameters:
    
    complianceSeverity - The severity level to assign to the association.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AssociationComplianceSeverity
  - withComplianceSeverity
```
public CreateAssociationBatchRequestEntry withComplianceSeverity(AssociationComplianceSeverity complianceSeverity)
```
    The severity level to assign to the association.
    
    Parameters:
    
    complianceSeverity - The severity level to assign 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 CreateAssociationBatchRequestEntry 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 CreateAssociationBatchRequestEntry 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 CreateAssociationBatchRequestEntry 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 CreateAssociationBatchRequestEntry 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 CreateAssociationBatchRequestEntry 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()
```
    Use this action to create an association in multiple Regions and multiple accounts.
    
    Returns:
    
    Use this action to create an association in multiple Regions and multiple accounts.
  - setTargetLocations
```
public void setTargetLocations(Collection<TargetLocation> targetLocations)
```
    Use this action to create an association in multiple Regions and multiple accounts.
    
    Parameters:
    
    targetLocations - Use this action to create an association in multiple Regions and multiple accounts.
  - withTargetLocations
```
public CreateAssociationBatchRequestEntry withTargetLocations(TargetLocation... targetLocations)
```
    Use this action to create an association in multiple Regions and multiple accounts.
    
    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 - Use this action to create an association in multiple Regions and multiple accounts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTargetLocations
```
public CreateAssociationBatchRequestEntry withTargetLocations(Collection<TargetLocation> targetLocations)
```
    Use this action to create an association in multiple Regions and multiple accounts.
    
    Parameters:
    
    targetLocations - Use this action to create an association in multiple Regions and multiple accounts.
    
    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 CreateAssociationBatchRequestEntry 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 CreateAssociationBatchRequestEntry 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 CreateAssociationBatchRequestEntry 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.
  - setAlarmConfiguration
```
public void setAlarmConfiguration(AlarmConfiguration alarmConfiguration)
```
    Parameters:
    
    alarmConfiguration -
  - getAlarmConfiguration
```
public AlarmConfiguration getAlarmConfiguration()
```
    Returns:
  - withAlarmConfiguration
```
public CreateAssociationBatchRequestEntry withAlarmConfiguration(AlarmConfiguration alarmConfiguration)
```
    Parameters:
    
    alarmConfiguration -
    
    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 CreateAssociationBatchRequestEntry 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.

AWS SDK for Java 1.x API Reference - 1.12.527

Class CreateAssociationBatchRequestEntry

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreateAssociationBatchRequestEntry

Method Detail

setName

getName

withName

setInstanceId

getInstanceId

withInstanceId

getParameters

setParameters

withParameters

addParametersEntry

clearParametersEntries

setAutomationTargetParameterName

getAutomationTargetParameterName

withAutomationTargetParameterName

setDocumentVersion

getDocumentVersion

withDocumentVersion

getTargets

setTargets

withTargets

withTargets

setScheduleExpression

getScheduleExpression

withScheduleExpression

setOutputLocation

getOutputLocation

withOutputLocation

setAssociationName

getAssociationName

withAssociationName

setMaxErrors

getMaxErrors

withMaxErrors

setMaxConcurrency

getMaxConcurrency

withMaxConcurrency

setComplianceSeverity

getComplianceSeverity

withComplianceSeverity

withComplianceSeverity

setSyncCompliance

getSyncCompliance

withSyncCompliance

withSyncCompliance

setApplyOnlyAtCronInterval

getApplyOnlyAtCronInterval

withApplyOnlyAtCronInterval

isApplyOnlyAtCronInterval

getCalendarNames

setCalendarNames

withCalendarNames

withCalendarNames

getTargetLocations

setTargetLocations

withTargetLocations

withTargetLocations

setScheduleOffset

getScheduleOffset

withScheduleOffset

getTargetMaps

setTargetMaps

withTargetMaps

withTargetMaps

setAlarmConfiguration

getAlarmConfiguration

withAlarmConfiguration

toString

equals

hashCode

clone

marshall