@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateAssociationBatchRequestEntry extends Object implements Serializable, Cloneable, StructuredPojo
Describes the association of a Systems Manager SSM document and an instance.
Constructor and Description |
---|
CreateAssociationBatchRequestEntry() |
Modifier and Type | Method and Description |
---|---|
CreateAssociationBatchRequestEntry |
addParametersEntry(String key,
List<String> value) |
CreateAssociationBatchRequestEntry |
clearParametersEntries()
Removes all the entries added into Parameters.
|
CreateAssociationBatchRequestEntry |
clone() |
boolean |
equals(Object obj) |
String |
getAssociationName()
Specify a descriptive name for the association.
|
String |
getAutomationTargetParameterName()
Specify the target for the association.
|
String |
getComplianceSeverity()
The severity level to assign to the association.
|
String |
getDocumentVersion()
The document version.
|
String |
getInstanceId()
The ID of the instance.
|
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 instance.
|
InstanceAssociationOutputLocation |
getOutputLocation()
An Amazon 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.
|
List<Target> |
getTargets()
The instances targeted by the request.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAssociationName(String associationName)
Specify a descriptive name for the association.
|
void |
setAutomationTargetParameterName(String automationTargetParameterName)
Specify the target for the association.
|
void |
setComplianceSeverity(String complianceSeverity)
The severity level to assign to the association.
|
void |
setDocumentVersion(String documentVersion)
The document version.
|
void |
setInstanceId(String instanceId)
The ID of the instance.
|
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 instance.
|
void |
setOutputLocation(InstanceAssociationOutputLocation outputLocation)
An Amazon 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 |
setTargets(Collection<Target> targets)
The instances targeted by the request.
|
String |
toString()
Returns a string representation of this object.
|
CreateAssociationBatchRequestEntry |
withAssociationName(String associationName)
Specify a descriptive name for the association.
|
CreateAssociationBatchRequestEntry |
withAutomationTargetParameterName(String automationTargetParameterName)
Specify the target for the association.
|
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 ID of the instance.
|
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 instance.
|
CreateAssociationBatchRequestEntry |
withOutputLocation(InstanceAssociationOutputLocation outputLocation)
An Amazon 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 |
withTargets(Collection<Target> targets)
The instances targeted by the request.
|
CreateAssociationBatchRequestEntry |
withTargets(Target... targets)
The instances targeted by the request.
|
public void setName(String name)
The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.
You can specify AWS-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 AWS 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 AWS-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
.
name
- The name of the SSM document that contains the configuration information for the instance. You can specify
Command or Automation documents.
You can specify AWS-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 AWS 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 AWS-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
.
public String getName()
The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.
You can specify AWS-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 AWS 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 AWS-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
.
You can specify AWS-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 AWS 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 AWS-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
.
public CreateAssociationBatchRequestEntry withName(String name)
The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.
You can specify AWS-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 AWS 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 AWS-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
.
name
- The name of the SSM document that contains the configuration information for the instance. You can specify
Command or Automation documents.
You can specify AWS-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 AWS 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 AWS-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
.
public void setInstanceId(String instanceId)
The ID of the instance.
instanceId
- The ID of the instance.public String getInstanceId()
The ID of the instance.
public CreateAssociationBatchRequestEntry withInstanceId(String instanceId)
The ID of the instance.
instanceId
- The ID of the instance.public Map<String,List<String>> getParameters()
A description of the parameters for a document.
public void setParameters(Map<String,List<String>> parameters)
A description of the parameters for a document.
parameters
- A description of the parameters for a document.public CreateAssociationBatchRequestEntry withParameters(Map<String,List<String>> parameters)
A description of the parameters for a document.
parameters
- A description of the parameters for a document.public CreateAssociationBatchRequestEntry addParametersEntry(String key, List<String> value)
public CreateAssociationBatchRequestEntry clearParametersEntries()
public void setAutomationTargetParameterName(String automationTargetParameterName)
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
automationTargetParameterName
- Specify the target for the association. This target is required for associations that use an Automation
document and target resources by using rate controls.public String getAutomationTargetParameterName()
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
public CreateAssociationBatchRequestEntry withAutomationTargetParameterName(String automationTargetParameterName)
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
automationTargetParameterName
- Specify the target for the association. This target is required for associations that use an Automation
document and target resources by using rate controls.public void setDocumentVersion(String documentVersion)
The document version.
documentVersion
- The document version.public String getDocumentVersion()
The document version.
public CreateAssociationBatchRequestEntry withDocumentVersion(String documentVersion)
The document version.
documentVersion
- The document version.public List<Target> getTargets()
The instances targeted by the request.
public void setTargets(Collection<Target> targets)
The instances targeted by the request.
targets
- The instances targeted by the request.public CreateAssociationBatchRequestEntry withTargets(Target... targets)
The instances targeted by the request.
NOTE: This method appends the values to the existing list (if any). Use
setTargets(java.util.Collection)
or withTargets(java.util.Collection)
if you want to override
the existing values.
targets
- The instances targeted by the request.public CreateAssociationBatchRequestEntry withTargets(Collection<Target> targets)
The instances targeted by the request.
targets
- The instances targeted by the request.public void setScheduleExpression(String scheduleExpression)
A cron expression that specifies a schedule when the association runs.
scheduleExpression
- A cron expression that specifies a schedule when the association runs.public String getScheduleExpression()
A cron expression that specifies a schedule when the association runs.
public CreateAssociationBatchRequestEntry withScheduleExpression(String scheduleExpression)
A cron expression that specifies a schedule when the association runs.
scheduleExpression
- A cron expression that specifies a schedule when the association runs.public void setOutputLocation(InstanceAssociationOutputLocation outputLocation)
An Amazon S3 bucket where you want to store the results of this request.
outputLocation
- An Amazon S3 bucket where you want to store the results of this request.public InstanceAssociationOutputLocation getOutputLocation()
An Amazon S3 bucket where you want to store the results of this request.
public CreateAssociationBatchRequestEntry withOutputLocation(InstanceAssociationOutputLocation outputLocation)
An Amazon S3 bucket where you want to store the results of this request.
outputLocation
- An Amazon S3 bucket where you want to store the results of this request.public void setAssociationName(String associationName)
Specify a descriptive name for the association.
associationName
- Specify a descriptive name for the association.public String getAssociationName()
Specify a descriptive name for the association.
public CreateAssociationBatchRequestEntry withAssociationName(String associationName)
Specify a descriptive name for the association.
associationName
- Specify a descriptive name for the association.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.
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.
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.
Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
public 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 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.
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.
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.
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.
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.
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.
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 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.
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.
public void setComplianceSeverity(String complianceSeverity)
The severity level to assign to the association.
complianceSeverity
- The severity level to assign to the association.AssociationComplianceSeverity
public String getComplianceSeverity()
The severity level to assign to the association.
AssociationComplianceSeverity
public CreateAssociationBatchRequestEntry withComplianceSeverity(String complianceSeverity)
The severity level to assign to the association.
complianceSeverity
- The severity level to assign to the association.AssociationComplianceSeverity
public CreateAssociationBatchRequestEntry withComplianceSeverity(AssociationComplianceSeverity complianceSeverity)
The severity level to assign to the association.
complianceSeverity
- The severity level to assign to the association.AssociationComplianceSeverity
public String toString()
toString
in class Object
Object.toString()
public CreateAssociationBatchRequestEntry clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.