@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateAssociationRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateAssociationRequest() |
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) |
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 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 document that contains the configuration information for the instance.
|
InstanceAssociationOutputLocation |
getOutputLocation()
An 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).
|
List<Target> |
getTargets()
The targets (either instances or tags) for the association.
|
int |
hashCode() |
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 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 document that contains the configuration information for the instance.
|
void |
setOutputLocation(InstanceAssociationOutputLocation outputLocation)
An 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 |
setTargets(Collection<Target> targets)
The targets (either instances or tags) for the association.
|
String |
toString()
Returns a string representation of this object.
|
CreateAssociationRequest |
withAssociationName(String associationName)
Specify a descriptive name for the association.
|
CreateAssociationRequest |
withAutomationTargetParameterName(String automationTargetParameterName)
Specify the target for the association.
|
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 document that contains the configuration information for the instance.
|
CreateAssociationRequest |
withOutputLocation(InstanceAssociationOutputLocation outputLocation)
An 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 |
withTargets(Collection<Target> targets)
The targets (either instances or tags) for the association.
|
CreateAssociationRequest |
withTargets(Target... targets)
The targets (either instances or tags) for the association.
|
addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
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:partition: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:partition: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:partition: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:partition: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 CreateAssociationRequest 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:partition: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:partition: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 setDocumentVersion(String documentVersion)
The document version you want to associate with the target(s). Can be a specific version or the default version.
documentVersion
- The document version you want to associate with the target(s). Can be a specific version or the default
version.public String getDocumentVersion()
The document version you want to associate with the target(s). Can be a specific version or the default version.
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.
documentVersion
- The document version you want to associate with the target(s). Can be a specific version or the default
version.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 SSM documents
that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId
,
you cannot use the parameters AssociationName
, DocumentVersion
, MaxErrors
,
MaxConcurrency
, OutputLocation
, or ScheduleExpression
. To use these
parameters, you must use the Targets
parameter.
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 SSM
documents that use schema version 2.0 or later will fail. In addition, if you use the parameter
InstanceId
, you cannot use the parameters AssociationName
,
DocumentVersion
, MaxErrors
, MaxConcurrency
,
OutputLocation
, or ScheduleExpression
. To use these parameters, you must use the
Targets
parameter.
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 SSM documents
that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId
,
you cannot use the parameters AssociationName
, DocumentVersion
, MaxErrors
,
MaxConcurrency
, OutputLocation
, or ScheduleExpression
. To use these
parameters, you must use the Targets
parameter.
InstanceId
has been deprecated. To specify an instance ID for an association, use the
Targets
parameter. Requests that include the parameter InstanceID
with SSM
documents that use schema version 2.0 or later will fail. In addition, if you use the parameter
InstanceId
, you cannot use the parameters AssociationName
,
DocumentVersion
, MaxErrors
, MaxConcurrency
,
OutputLocation
, or ScheduleExpression
. To use these parameters, you must use
the Targets
parameter.
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 SSM documents
that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId
,
you cannot use the parameters AssociationName
, DocumentVersion
, MaxErrors
,
MaxConcurrency
, OutputLocation
, or ScheduleExpression
. To use these
parameters, you must use the Targets
parameter.
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 SSM
documents that use schema version 2.0 or later will fail. In addition, if you use the parameter
InstanceId
, you cannot use the parameters AssociationName
,
DocumentVersion
, MaxErrors
, MaxConcurrency
,
OutputLocation
, or ScheduleExpression
. To use these parameters, you must use the
Targets
parameter.
public Map<String,List<String>> getParameters()
The parameters for the runtime configuration of the document.
public void setParameters(Map<String,List<String>> parameters)
The parameters for the runtime configuration of the document.
parameters
- The parameters for the runtime configuration of the document.public CreateAssociationRequest withParameters(Map<String,List<String>> parameters)
The parameters for the runtime configuration of the document.
parameters
- The parameters for the runtime configuration of the document.public CreateAssociationRequest addParametersEntry(String key, List<String> value)
public CreateAssociationRequest clearParametersEntries()
public List<Target> getTargets()
The targets (either instances or tags) for the association. You must specify a value for Targets
if
you don't specify a value for InstanceId
.
Targets
if you don't specify a value for InstanceId
.public void setTargets(Collection<Target> targets)
The targets (either instances or tags) for the association. You must specify a value for Targets
if
you don't specify a value for InstanceId
.
targets
- The targets (either instances or tags) for the association. You must specify a value for
Targets
if you don't specify a value for InstanceId
.public CreateAssociationRequest withTargets(Target... targets)
The targets (either instances or tags) for the association. You must specify a value for Targets
if
you don't specify a value for InstanceId
.
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 targets (either instances or tags) for the association. You must specify a value for
Targets
if you don't specify a value for InstanceId
.public CreateAssociationRequest withTargets(Collection<Target> targets)
The targets (either instances or tags) for the association. You must specify a value for Targets
if
you don't specify a value for InstanceId
.
targets
- The targets (either instances or tags) for the association. You must specify a value for
Targets
if you don't specify a value for InstanceId
.public void setScheduleExpression(String scheduleExpression)
A cron expression when the association will be applied to the target(s).
scheduleExpression
- A cron expression when the association will be applied to the target(s).public String getScheduleExpression()
A cron expression when the association will be applied to the target(s).
public CreateAssociationRequest withScheduleExpression(String scheduleExpression)
A cron expression when the association will be applied to the target(s).
scheduleExpression
- A cron expression when the association will be applied to the target(s).public void setOutputLocation(InstanceAssociationOutputLocation outputLocation)
An Amazon S3 bucket where you want to store the output details of the request.
outputLocation
- An Amazon S3 bucket where you want to store the output details of the request.public InstanceAssociationOutputLocation getOutputLocation()
An Amazon S3 bucket where you want to store the output details of the request.
public CreateAssociationRequest withOutputLocation(InstanceAssociationOutputLocation outputLocation)
An Amazon S3 bucket where you want to store the output details of the request.
outputLocation
- An Amazon S3 bucket where you want to store the output details of the 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 CreateAssociationRequest withAssociationName(String associationName)
Specify a descriptive name for the association.
associationName
- Specify a descriptive name for the association.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 CreateAssociationRequest 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 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 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.
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 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.
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 CreateAssociationRequest withComplianceSeverity(String complianceSeverity)
The severity level to assign to the association.
complianceSeverity
- The severity level to assign to the association.AssociationComplianceSeverity
public CreateAssociationRequest 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 CreateAssociationRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2020. All rights reserved.