CreateAssociationRequest (AWS Java SDK for the AWS Simple Systems Management (SSM) Service 1.12.52 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.simplesystemsmanagement.model.CreateAssociationRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateAssociationRequest()

Constructors
Constructor and Description
`CreateAssociationRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateAssociationRequest`	`addParametersEntry(String key, List<String> value)` Add a single Parameters entry
`CreateAssociationRequest`	`clearParametersEntries()` Removes all the entries added into Parameters.
`CreateAssociationRequest`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getApplyOnlyAtCronInterval()` By default, when you create a new association, 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 you want to gate your associations under.
`String`	`getComplianceSeverity()` The severity level to assign to the association.
`String`	`getDocumentVersion()` The document version you want to associate with the target(s).
`String`	`getInstanceId()` The instance 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 Command document or Automation runbook that contains the configuration information for the instance.
`InstanceAssociationOutputLocation`	`getOutputLocation()` An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
`Map<String,List<String>>`	`getParameters()` The parameters for the runtime configuration of the document.
`String`	`getScheduleExpression()` A cron expression when the association will be applied to the target(s).
`String`	`getSyncCompliance()` The mode for generating association compliance.
`List<TargetLocation>`	`getTargetLocations()` A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.
`List<Target>`	`getTargets()` The targets for the association.
`int`	`hashCode()`
`Boolean`	`isApplyOnlyAtCronInterval()` By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified.
`void`	`setApplyOnlyAtCronInterval(Boolean applyOnlyAtCronInterval)` By default, when you create a new association, 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 you want to gate your associations under.
`void`	`setComplianceSeverity(String complianceSeverity)` The severity level to assign to the association.
`void`	`setDocumentVersion(String documentVersion)` The document version you want to associate with the target(s).
`void`	`setInstanceId(String instanceId)` The instance 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 Command document or Automation runbook that contains the configuration information for the instance.
`void`	`setOutputLocation(InstanceAssociationOutputLocation outputLocation)` An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
`void`	`setParameters(Map<String,List<String>> parameters)` The parameters for the runtime configuration of the document.
`void`	`setScheduleExpression(String scheduleExpression)` A cron expression when the association will be applied to the target(s).
`void`	`setSyncCompliance(String syncCompliance)` The mode for generating association compliance.
`void`	`setTargetLocations(Collection<TargetLocation> targetLocations)` A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.
`void`	`setTargets(Collection<Target> targets)` The targets for the association.
`String`	`toString()` Returns a string representation of this object.
`CreateAssociationRequest`	`withApplyOnlyAtCronInterval(Boolean applyOnlyAtCronInterval)` By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified.
`CreateAssociationRequest`	`withAssociationName(String associationName)` Specify a descriptive name for the association.
`CreateAssociationRequest`	`withAutomationTargetParameterName(String automationTargetParameterName)` Specify the target for the association.
`CreateAssociationRequest`	`withCalendarNames(Collection<String> calendarNames)` The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under.
`CreateAssociationRequest`	`withCalendarNames(String... calendarNames)` The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under.
`CreateAssociationRequest`	`withComplianceSeverity(AssociationComplianceSeverity complianceSeverity)` The severity level to assign to the association.
`CreateAssociationRequest`	`withComplianceSeverity(String complianceSeverity)` The severity level to assign to the association.
`CreateAssociationRequest`	`withDocumentVersion(String documentVersion)` The document version you want to associate with the target(s).
`CreateAssociationRequest`	`withInstanceId(String instanceId)` The instance ID.
`CreateAssociationRequest`	`withMaxConcurrency(String maxConcurrency)` The maximum number of targets allowed to run the association at the same time.
`CreateAssociationRequest`	`withMaxErrors(String maxErrors)` The number of errors that are allowed before the system stops sending requests to run the association on additional targets.
`CreateAssociationRequest`	`withName(String name)` The name of the SSM Command document or Automation runbook that contains the configuration information for the instance.
`CreateAssociationRequest`	`withOutputLocation(InstanceAssociationOutputLocation outputLocation)` An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
`CreateAssociationRequest`	`withParameters(Map<String,List<String>> parameters)` The parameters for the runtime configuration of the document.
`CreateAssociationRequest`	`withScheduleExpression(String scheduleExpression)` A cron expression when the association will be applied to the target(s).
`CreateAssociationRequest`	`withSyncCompliance(AssociationSyncCompliance syncCompliance)` The mode for generating association compliance.
`CreateAssociationRequest`	`withSyncCompliance(String syncCompliance)` The mode for generating association compliance.
`CreateAssociationRequest`	`withTargetLocations(Collection<TargetLocation> targetLocations)` A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.
`CreateAssociationRequest`	`withTargetLocations(TargetLocation... targetLocations)` A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.
`CreateAssociationRequest`	`withTargets(Collection<Target> targets)` The targets for the association.
`CreateAssociationRequest`	`withTargets(Target... targets)` The targets for the association.

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

- Constructor Detail
  - CreateAssociationRequest
```
public CreateAssociationRequest()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the SSM Command document or Automation runbook that contains the configuration information for the instance.
    
    You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
    
    For Systems Manager documents (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:partition: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 Command document or Automation runbook that contains the configuration information for the instance.
    
    You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
    
    For Systems Manager documents (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:partition: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 Command document or Automation runbook that contains the configuration information for the instance.
    
    You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
    
    For Systems Manager documents (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:partition: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 Command document or Automation runbook that contains the configuration information for the instance.
    
    You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
    
    For Systems Manager documents (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:partition: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 CreateAssociationRequest withName(String name)
```
    The name of the SSM Command document or Automation runbook that contains the configuration information for the instance.
    
    You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
    
    For Systems Manager documents (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:partition: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 Command document or Automation runbook that contains the configuration information for the instance.
    
    You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
    
    For Systems Manager documents (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:partition: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.
  - setDocumentVersion
```
public void setDocumentVersion(String documentVersion)
```
    The document version you want to associate with the target(s). Can be a specific version or the default version.
    
    Parameters:
    
    documentVersion - The document version you want to associate with the target(s). Can be a specific version or the default version.
  - getDocumentVersion
```
public String getDocumentVersion()
```
    The document version you want to associate with the target(s). Can be a specific version or the default version.
    
    Returns:
    
    The document version you want to associate with the target(s). Can be a specific version or the default version.
  - withDocumentVersion
```
public CreateAssociationRequest withDocumentVersion(String documentVersion)
```
    The document version you want to associate with the target(s). Can be a specific version or the default version.
    
    Parameters:
    
    documentVersion - The document version you want to associate with the target(s). Can be a specific version or the default version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceId
```
public void setInstanceId(String instanceId)
```
    The instance ID.
    
    InstanceId has been deprecated. To specify an instance 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 instance ID.
    
    InstanceId has been deprecated. To specify an instance 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 instance ID.
    
    InstanceId has been deprecated. To specify an instance 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 instance ID.
    
    InstanceId has been deprecated. To specify an instance 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 CreateAssociationRequest withInstanceId(String instanceId)
```
    The instance ID.
    
    InstanceId has been deprecated. To specify an instance 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 instance ID.
    
    InstanceId has been deprecated. To specify an instance 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()
```
    The parameters for the runtime configuration of the document.
    
    Returns:
    
    The parameters for the runtime configuration of the document.
  - setParameters
```
public void setParameters(Map<String,List<String>> parameters)
```
    The parameters for the runtime configuration of the document.
    
    Parameters:
    
    parameters - The parameters for the runtime configuration of the document.
  - withParameters
```
public CreateAssociationRequest withParameters(Map<String,List<String>> parameters)
```
    The parameters for the runtime configuration of the document.
    
    Parameters:
    
    parameters - The parameters for the runtime configuration of the document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addParametersEntry
```
public CreateAssociationRequest 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 CreateAssociationRequest clearParametersEntries()
```
    Removes all the entries added into Parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTargets
```
public List<Target> getTargets()
```
    The targets for the association. You can target instances by using tags, Amazon Web Services resource groups, all instances in an Amazon Web Services account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the Amazon Web Services Systems Manager User Guide.
    
    Returns:
    
    The targets for the association. You can target instances by using tags, Amazon Web Services resource groups, all instances in an Amazon Web Services account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the Amazon Web Services Systems Manager User Guide.
  - setTargets
```
public void setTargets(Collection<Target> targets)
```
    The targets for the association. You can target instances by using tags, Amazon Web Services resource groups, all instances in an Amazon Web Services account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the Amazon Web Services Systems Manager User Guide.
    
    Parameters:
    
    targets - The targets for the association. You can target instances by using tags, Amazon Web Services resource groups, all instances in an Amazon Web Services account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the Amazon Web Services Systems Manager User Guide.
  - withTargets
```
public CreateAssociationRequest withTargets(Target... targets)
```
    The targets for the association. You can target instances by using tags, Amazon Web Services resource groups, all instances in an Amazon Web Services account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the Amazon Web Services Systems Manager User Guide.
    
    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 targets for the association. You can target instances by using tags, Amazon Web Services resource groups, all instances in an Amazon Web Services account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the Amazon Web Services Systems Manager User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTargets
```
public CreateAssociationRequest withTargets(Collection<Target> targets)
```
    The targets for the association. You can target instances by using tags, Amazon Web Services resource groups, all instances in an Amazon Web Services account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the Amazon Web Services Systems Manager User Guide.
    
    Parameters:
    
    targets - The targets for the association. You can target instances by using tags, Amazon Web Services resource groups, all instances in an Amazon Web Services account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the Amazon Web Services Systems Manager User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setScheduleExpression
```
public void setScheduleExpression(String scheduleExpression)
```
    A cron expression when the association will be applied to the target(s).
    
    Parameters:
    
    scheduleExpression - A cron expression when the association will be applied to the target(s).
  - getScheduleExpression
```
public String getScheduleExpression()
```
    A cron expression when the association will be applied to the target(s).
    
    Returns:
    
    A cron expression when the association will be applied to the target(s).
  - withScheduleExpression
```
public CreateAssociationRequest withScheduleExpression(String scheduleExpression)
```
    A cron expression when the association will be applied to the target(s).
    
    Parameters:
    
    scheduleExpression - A cron expression when the association will be applied to the target(s).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputLocation
```
public void setOutputLocation(InstanceAssociationOutputLocation outputLocation)
```
    An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
    
    Parameters:
    
    outputLocation - An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
  - getOutputLocation
```
public InstanceAssociationOutputLocation getOutputLocation()
```
    An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
    
    Returns:
    
    An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
  - withOutputLocation
```
public CreateAssociationRequest withOutputLocation(InstanceAssociationOutputLocation outputLocation)
```
    An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
    
    Parameters:
    
    outputLocation - An Amazon Simple Storage Service (Amazon 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.
  - 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 CreateAssociationRequest 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.
  - 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 CreateAssociationRequest 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.
  - 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 instances 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 instances 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 instances 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 instances 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 CreateAssociationRequest 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 instances 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 instances 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 instance 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 instance 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 instance 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 instance 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 instance 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 instance 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 instance 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 instance will process its association within the limit specified for MaxConcurrency.
  - withMaxConcurrency
```
public CreateAssociationRequest 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 instance 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 instance 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 instance 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 instance 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 CreateAssociationRequest 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 CreateAssociationRequest 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. 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. 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. 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. It is managed by your direct call to the PutComplianceItems API operation.
    
    By default, all associations use AUTO mode.
    
    See Also:
    
    AssociationSyncCompliance
  - withSyncCompliance
```
public CreateAssociationRequest 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. 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. 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 CreateAssociationRequest 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. 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. 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 association, 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 association, 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 association, 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 association, 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 CreateAssociationRequest withApplyOnlyAtCronInterval(Boolean applyOnlyAtCronInterval)
```
    By default, when you create a new association, 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 association, 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 association, 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 association, 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 you want to gate your associations 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 you want to gate your associations 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 you want to gate your associations 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 you want to gate your associations under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
  - withCalendarNames
```
public CreateAssociationRequest withCalendarNames(String... calendarNames)
```
    The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations 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 you want to gate your associations 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 CreateAssociationRequest withCalendarNames(Collection<String> calendarNames)
```
    The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations 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 you want to gate your associations 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()
```
    A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.
    
    Returns:
    
    A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.
  - setTargetLocations
```
public void setTargetLocations(Collection<TargetLocation> targetLocations)
```
    A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.
    
    Parameters:
    
    targetLocations - A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.
  - withTargetLocations
```
public CreateAssociationRequest withTargetLocations(TargetLocation... targetLocations)
```
    A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. 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 - A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. 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 CreateAssociationRequest withTargetLocations(Collection<TargetLocation> targetLocations)
```
    A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.
    
    Parameters:
    
    targetLocations - A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. 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.
  - 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 CreateAssociationRequest clone()
```
    Overrides:
    
    clone in class AmazonWebServiceRequest

Class CreateAssociationRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateAssociationRequest

Method Detail

setName

getName

withName

setDocumentVersion

getDocumentVersion

withDocumentVersion

setInstanceId

getInstanceId

withInstanceId

getParameters

setParameters

withParameters

addParametersEntry

clearParametersEntries

getTargets

setTargets

withTargets

withTargets

setScheduleExpression

getScheduleExpression

withScheduleExpression

setOutputLocation

getOutputLocation

withOutputLocation

setAssociationName

getAssociationName

withAssociationName

setAutomationTargetParameterName

getAutomationTargetParameterName

withAutomationTargetParameterName

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

toString

equals

hashCode

clone