@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateAssociationBatchRequestEntry extends Object implements Serializable, Cloneable, StructuredPojo
Describes the association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.
Constructor and Description |
---|
CreateAssociationBatchRequestEntry() |
Modifier and Type | Method and Description |
---|---|
CreateAssociationBatchRequestEntry |
addParametersEntry(String key,
List<String> value)
Add a single Parameters entry
|
CreateAssociationBatchRequestEntry |
clearParametersEntries()
Removes all the entries added into Parameters.
|
CreateAssociationBatchRequestEntry |
clone() |
boolean |
equals(Object obj) |
AlarmConfiguration |
getAlarmConfiguration() |
Boolean |
getApplyOnlyAtCronInterval()
By default, when you create a new associations, the system runs it immediately after it is created and then
according to the schedule you specified.
|
String |
getAssociationName()
Specify a descriptive name for the association.
|
String |
getAutomationTargetParameterName()
Specify the target for the association.
|
List<String> |
getCalendarNames()
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated
under.
|
String |
getComplianceSeverity()
The severity level to assign to the association.
|
String |
getDocumentVersion()
The document version.
|
Integer |
getDuration()
The number of hours the association can run before it is canceled.
|
String |
getInstanceId()
The managed node ID.
|
String |
getMaxConcurrency()
The maximum number of targets allowed to run the association at the same time.
|
String |
getMaxErrors()
The number of errors that are allowed before the system stops sending requests to run the association on
additional targets.
|
String |
getName()
The name of the SSM document that contains the configuration information for the managed node.
|
InstanceAssociationOutputLocation |
getOutputLocation()
An S3 bucket where you want to store the results of this request.
|
Map<String,List<String>> |
getParameters()
A description of the parameters for a document.
|
String |
getScheduleExpression()
A cron expression that specifies a schedule when the association runs.
|
Integer |
getScheduleOffset()
Number of days to wait after the scheduled day to run an association.
|
String |
getSyncCompliance()
The mode for generating association compliance.
|
List<TargetLocation> |
getTargetLocations()
Use this action to create an association in multiple Regions and multiple accounts.
|
List<Map<String,List<String>>> |
getTargetMaps()
A key-value mapping of document parameters to target resources.
|
List<Target> |
getTargets()
The managed nodes targeted by the request.
|
int |
hashCode() |
Boolean |
isApplyOnlyAtCronInterval()
By default, when you create a new associations, the system runs it immediately after it is created and then
according to the schedule you specified.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAlarmConfiguration(AlarmConfiguration alarmConfiguration) |
void |
setApplyOnlyAtCronInterval(Boolean applyOnlyAtCronInterval)
By default, when you create a new associations, the system runs it immediately after it is created and then
according to the schedule you specified.
|
void |
setAssociationName(String associationName)
Specify a descriptive name for the association.
|
void |
setAutomationTargetParameterName(String automationTargetParameterName)
Specify the target for the association.
|
void |
setCalendarNames(Collection<String> calendarNames)
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated
under.
|
void |
setComplianceSeverity(String complianceSeverity)
The severity level to assign to the association.
|
void |
setDocumentVersion(String documentVersion)
The document version.
|
void |
setDuration(Integer duration)
The number of hours the association can run before it is canceled.
|
void |
setInstanceId(String instanceId)
The managed node ID.
|
void |
setMaxConcurrency(String maxConcurrency)
The maximum number of targets allowed to run the association at the same time.
|
void |
setMaxErrors(String maxErrors)
The number of errors that are allowed before the system stops sending requests to run the association on
additional targets.
|
void |
setName(String name)
The name of the SSM document that contains the configuration information for the managed node.
|
void |
setOutputLocation(InstanceAssociationOutputLocation outputLocation)
An S3 bucket where you want to store the results of this request.
|
void |
setParameters(Map<String,List<String>> parameters)
A description of the parameters for a document.
|
void |
setScheduleExpression(String scheduleExpression)
A cron expression that specifies a schedule when the association runs.
|
void |
setScheduleOffset(Integer scheduleOffset)
Number of days to wait after the scheduled day to run an association.
|
void |
setSyncCompliance(String syncCompliance)
The mode for generating association compliance.
|
void |
setTargetLocations(Collection<TargetLocation> targetLocations)
Use this action to create an association in multiple Regions and multiple accounts.
|
void |
setTargetMaps(Collection<Map<String,List<String>>> targetMaps)
A key-value mapping of document parameters to target resources.
|
void |
setTargets(Collection<Target> targets)
The managed nodes targeted by the request.
|
String |
toString()
Returns a string representation of this object.
|
CreateAssociationBatchRequestEntry |
withAlarmConfiguration(AlarmConfiguration alarmConfiguration) |
CreateAssociationBatchRequestEntry |
withApplyOnlyAtCronInterval(Boolean applyOnlyAtCronInterval)
By default, when you create a new associations, the system runs it immediately after it is created and then
according to the schedule you specified.
|
CreateAssociationBatchRequestEntry |
withAssociationName(String associationName)
Specify a descriptive name for the association.
|
CreateAssociationBatchRequestEntry |
withAutomationTargetParameterName(String automationTargetParameterName)
Specify the target for the association.
|
CreateAssociationBatchRequestEntry |
withCalendarNames(Collection<String> calendarNames)
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated
under.
|
CreateAssociationBatchRequestEntry |
withCalendarNames(String... calendarNames)
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated
under.
|
CreateAssociationBatchRequestEntry |
withComplianceSeverity(AssociationComplianceSeverity complianceSeverity)
The severity level to assign to the association.
|
CreateAssociationBatchRequestEntry |
withComplianceSeverity(String complianceSeverity)
The severity level to assign to the association.
|
CreateAssociationBatchRequestEntry |
withDocumentVersion(String documentVersion)
The document version.
|
CreateAssociationBatchRequestEntry |
withDuration(Integer duration)
The number of hours the association can run before it is canceled.
|
CreateAssociationBatchRequestEntry |
withInstanceId(String instanceId)
The managed node ID.
|
CreateAssociationBatchRequestEntry |
withMaxConcurrency(String maxConcurrency)
The maximum number of targets allowed to run the association at the same time.
|
CreateAssociationBatchRequestEntry |
withMaxErrors(String maxErrors)
The number of errors that are allowed before the system stops sending requests to run the association on
additional targets.
|
CreateAssociationBatchRequestEntry |
withName(String name)
The name of the SSM document that contains the configuration information for the managed node.
|
CreateAssociationBatchRequestEntry |
withOutputLocation(InstanceAssociationOutputLocation outputLocation)
An S3 bucket where you want to store the results of this request.
|
CreateAssociationBatchRequestEntry |
withParameters(Map<String,List<String>> parameters)
A description of the parameters for a document.
|
CreateAssociationBatchRequestEntry |
withScheduleExpression(String scheduleExpression)
A cron expression that specifies a schedule when the association runs.
|
CreateAssociationBatchRequestEntry |
withScheduleOffset(Integer scheduleOffset)
Number of days to wait after the scheduled day to run an association.
|
CreateAssociationBatchRequestEntry |
withSyncCompliance(AssociationSyncCompliance syncCompliance)
The mode for generating association compliance.
|
CreateAssociationBatchRequestEntry |
withSyncCompliance(String syncCompliance)
The mode for generating association compliance.
|
CreateAssociationBatchRequestEntry |
withTargetLocations(Collection<TargetLocation> targetLocations)
Use this action to create an association in multiple Regions and multiple accounts.
|
CreateAssociationBatchRequestEntry |
withTargetLocations(TargetLocation... targetLocations)
Use this action to create an association in multiple Regions and multiple accounts.
|
CreateAssociationBatchRequestEntry |
withTargetMaps(Collection<Map<String,List<String>>> targetMaps)
A key-value mapping of document parameters to target resources.
|
CreateAssociationBatchRequestEntry |
withTargetMaps(Map<String,List<String>>... targetMaps)
A key-value mapping of document parameters to target resources.
|
CreateAssociationBatchRequestEntry |
withTargets(Collection<Target> targets)
The managed nodes targeted by the request.
|
CreateAssociationBatchRequestEntry |
withTargets(Target... targets)
The managed nodes targeted by the request.
|
public void setName(String name)
The name of the SSM document that contains the configuration information for the managed node. You can specify Command or Automation runbooks.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For SSM documents that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to
specify the document name. For example, AWS-ApplyPatchBaseline
or My-Document
.
name
- The name of the SSM document that contains the configuration information for the managed node. You can
specify Command or Automation runbooks.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For SSM documents that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need
to specify the document name. For example, AWS-ApplyPatchBaseline
or My-Document
.
public String getName()
The name of the SSM document that contains the configuration information for the managed node. You can specify Command or Automation runbooks.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For SSM documents that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to
specify the document name. For example, AWS-ApplyPatchBaseline
or My-Document
.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For SSM documents that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need
to specify the document name. For example, AWS-ApplyPatchBaseline
or
My-Document
.
public CreateAssociationBatchRequestEntry withName(String name)
The name of the SSM document that contains the configuration information for the managed node. You can specify Command or Automation runbooks.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For SSM documents that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to
specify the document name. For example, AWS-ApplyPatchBaseline
or My-Document
.
name
- The name of the SSM document that contains the configuration information for the managed node. You can
specify Command or Automation runbooks.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For SSM documents that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need
to specify the document name. For example, AWS-ApplyPatchBaseline
or My-Document
.
public void setInstanceId(String instanceId)
The managed node ID.
InstanceId
has been deprecated. To specify a managed node ID for an association, use the
Targets
parameter. Requests that include the parameter InstanceID
with Systems Manager
documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter
InstanceId
, you can't use the parameters AssociationName
, DocumentVersion
,
MaxErrors
, MaxConcurrency
, OutputLocation
, or
ScheduleExpression
. To use these parameters, you must use the Targets
parameter.
instanceId
- The managed node ID.
InstanceId
has been deprecated. To specify a managed node ID for an association, use the
Targets
parameter. Requests that include the parameter InstanceID
with Systems
Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use
the parameter InstanceId
, you can't use the parameters AssociationName
,
DocumentVersion
, MaxErrors
, MaxConcurrency
,
OutputLocation
, or ScheduleExpression
. To use these parameters, you must use the
Targets
parameter.
public String getInstanceId()
The managed node ID.
InstanceId
has been deprecated. To specify a managed node ID for an association, use the
Targets
parameter. Requests that include the parameter InstanceID
with Systems Manager
documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter
InstanceId
, you can't use the parameters AssociationName
, DocumentVersion
,
MaxErrors
, MaxConcurrency
, OutputLocation
, or
ScheduleExpression
. To use these parameters, you must use the Targets
parameter.
InstanceId
has been deprecated. To specify a managed node ID for an association, use the
Targets
parameter. Requests that include the parameter InstanceID
with Systems
Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use
the parameter InstanceId
, you can't use the parameters AssociationName
,
DocumentVersion
, MaxErrors
, MaxConcurrency
,
OutputLocation
, or ScheduleExpression
. To use these parameters, you must use
the Targets
parameter.
public CreateAssociationBatchRequestEntry withInstanceId(String instanceId)
The managed node ID.
InstanceId
has been deprecated. To specify a managed node ID for an association, use the
Targets
parameter. Requests that include the parameter InstanceID
with Systems Manager
documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter
InstanceId
, you can't use the parameters AssociationName
, DocumentVersion
,
MaxErrors
, MaxConcurrency
, OutputLocation
, or
ScheduleExpression
. To use these parameters, you must use the Targets
parameter.
instanceId
- The managed node ID.
InstanceId
has been deprecated. To specify a managed node ID for an association, use the
Targets
parameter. Requests that include the parameter InstanceID
with Systems
Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use
the parameter InstanceId
, you can't use the parameters AssociationName
,
DocumentVersion
, MaxErrors
, MaxConcurrency
,
OutputLocation
, or ScheduleExpression
. To use these parameters, you must use the
Targets
parameter.
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 runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
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.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.
public CreateAssociationBatchRequestEntry withAutomationTargetParameterName(String automationTargetParameterName)
Specify the target for the association. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
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.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 managed nodes targeted by the request.
public void setTargets(Collection<Target> targets)
The managed nodes targeted by the request.
targets
- The managed nodes targeted by the request.public CreateAssociationBatchRequestEntry withTargets(Target... targets)
The managed nodes targeted by the request.
NOTE: This method appends the values to the existing list (if any). Use
setTargets(java.util.Collection)
or withTargets(java.util.Collection)
if you want to override
the existing values.
targets
- The managed nodes targeted by the request.public CreateAssociationBatchRequestEntry withTargets(Collection<Target> targets)
The managed nodes targeted by the request.
targets
- The managed nodes 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 S3 bucket where you want to store the results of this request.
outputLocation
- An S3 bucket where you want to store the results of this request.public InstanceAssociationOutputLocation getOutputLocation()
An S3 bucket where you want to store the results of this request.
public CreateAssociationBatchRequestEntry withOutputLocation(InstanceAssociationOutputLocation outputLocation)
An S3 bucket where you want to store the results of this request.
outputLocation
- An 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 managed nodes and set MaxError
to 10%, then the system stops sending
the request when the sixth error is received.
Executions that are already running an association when MaxErrors
is reached are allowed to
complete, but some of these executions may fail as well. If you need to ensure that there won't be more than
max-errors failed executions, set MaxConcurrency
to 1 so that executions proceed one at a time.
maxErrors
- The number of errors that are allowed before the system stops sending requests to run the association on
additional targets. You can specify either an absolute number of errors, for example 10, or a percentage
of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when
the fourth error is received. If you specify 0, then the system stops sending requests after the first
error is returned. If you run an association on 50 managed nodes and set MaxError
to 10%,
then the system stops sending the request when the sixth error is received.
Executions that are already running an association when MaxErrors
is reached are allowed to
complete, but some of these executions may fail as well. If you need to ensure that there won't be more
than max-errors failed executions, set MaxConcurrency
to 1 so that executions proceed one at
a time.
public String getMaxErrors()
The number of errors that are allowed before the system stops sending requests to run the association on
additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the
target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth
error is received. If you specify 0, then the system stops sending requests after the first error is returned. If
you run an association on 50 managed nodes and set MaxError
to 10%, then the system stops sending
the request when the sixth error is received.
Executions that are already running an association when MaxErrors
is reached are allowed to
complete, but some of these executions may fail as well. If you need to ensure that there won't be more than
max-errors failed executions, set MaxConcurrency
to 1 so that executions proceed one at a time.
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 CreateAssociationBatchRequestEntry withMaxErrors(String maxErrors)
The number of errors that are allowed before the system stops sending requests to run the association on
additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the
target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth
error is received. If you specify 0, then the system stops sending requests after the first error is returned. If
you run an association on 50 managed nodes and set MaxError
to 10%, then the system stops sending
the request when the sixth error is received.
Executions that are already running an association when MaxErrors
is reached are allowed to
complete, but some of these executions may fail as well. If you need to ensure that there won't be more than
max-errors failed executions, set MaxConcurrency
to 1 so that executions proceed one at a time.
maxErrors
- The number of errors that are allowed before the system stops sending requests to run the association on
additional targets. You can specify either an absolute number of errors, for example 10, or a percentage
of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when
the fourth error is received. If you specify 0, then the system stops sending requests after the first
error is returned. If you run an association on 50 managed nodes and set MaxError
to 10%,
then the system stops sending the request when the sixth error is received.
Executions that are already running an association when MaxErrors
is reached are allowed to
complete, but some of these executions may fail as well. If you need to ensure that there won't be more
than max-errors failed executions, set MaxConcurrency
to 1 so that executions proceed one at
a time.
public void setMaxConcurrency(String maxConcurrency)
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
If a new managed node starts and attempts to run an association while Systems Manager is running
MaxConcurrency
associations, the association is allowed to run. During the next association
interval, the new managed node will process its association within the limit specified for
MaxConcurrency
.
maxConcurrency
- The maximum number of targets allowed to run the association at the same time. You can specify a number,
for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means
all targets run the association at the same time.
If a new managed node starts and attempts to run an association while Systems Manager is running
MaxConcurrency
associations, the association is allowed to run. During the next association
interval, the new managed node will process its association within the limit specified for
MaxConcurrency
.
public String getMaxConcurrency()
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
If a new managed node starts and attempts to run an association while Systems Manager is running
MaxConcurrency
associations, the association is allowed to run. During the next association
interval, the new managed node will process its association within the limit specified for
MaxConcurrency
.
If a new managed node starts and attempts to run an association while Systems Manager is running
MaxConcurrency
associations, the association is allowed to run. During the next association
interval, the new managed node will process its association within the limit specified for
MaxConcurrency
.
public CreateAssociationBatchRequestEntry withMaxConcurrency(String maxConcurrency)
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
If a new managed node starts and attempts to run an association while Systems Manager is running
MaxConcurrency
associations, the association is allowed to run. During the next association
interval, the new managed node will process its association within the limit specified for
MaxConcurrency
.
maxConcurrency
- The maximum number of targets allowed to run the association at the same time. You can specify a number,
for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means
all targets run the association at the same time.
If a new managed node starts and attempts to run an association while Systems Manager is running
MaxConcurrency
associations, the association is allowed to run. During the next association
interval, the new managed node will process its association within the limit specified for
MaxConcurrency
.
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 void setSyncCompliance(String syncCompliance)
The mode for generating association compliance. You can specify AUTO
or MANUAL
. In
AUTO
mode, the system uses the status of the association execution to determine the compliance
status. If the association execution runs successfully, then the association is COMPLIANT
. If the
association execution doesn't run successfully, the association is NON-COMPLIANT
.
In MANUAL
mode, you must specify the AssociationId
as a parameter for the
PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a
capability of Amazon Web Services Systems Manager. It is managed by your direct call to the
PutComplianceItems API operation.
By default, all associations use AUTO
mode.
syncCompliance
- The mode for generating association compliance. You can specify AUTO
or MANUAL
.
In AUTO
mode, the system uses the status of the association execution to determine the
compliance status. If the association execution runs successfully, then the association is
COMPLIANT
. If the association execution doesn't run successfully, the association is
NON-COMPLIANT
.
In MANUAL
mode, you must specify the AssociationId
as a parameter for the
PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a
capability of Amazon Web Services Systems Manager. It is managed by your direct call to the
PutComplianceItems API operation.
By default, all associations use AUTO
mode.
AssociationSyncCompliance
public String getSyncCompliance()
The mode for generating association compliance. You can specify AUTO
or MANUAL
. In
AUTO
mode, the system uses the status of the association execution to determine the compliance
status. If the association execution runs successfully, then the association is COMPLIANT
. If the
association execution doesn't run successfully, the association is NON-COMPLIANT
.
In MANUAL
mode, you must specify the AssociationId
as a parameter for the
PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a
capability of Amazon Web Services Systems Manager. It is managed by your direct call to the
PutComplianceItems API operation.
By default, all associations use AUTO
mode.
AUTO
or MANUAL
.
In AUTO
mode, the system uses the status of the association execution to determine the
compliance status. If the association execution runs successfully, then the association is
COMPLIANT
. If the association execution doesn't run successfully, the association is
NON-COMPLIANT
.
In MANUAL
mode, you must specify the AssociationId
as a parameter for the
PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a
capability of Amazon Web Services Systems Manager. It is managed by your direct call to the
PutComplianceItems API operation.
By default, all associations use AUTO
mode.
AssociationSyncCompliance
public CreateAssociationBatchRequestEntry withSyncCompliance(String syncCompliance)
The mode for generating association compliance. You can specify AUTO
or MANUAL
. In
AUTO
mode, the system uses the status of the association execution to determine the compliance
status. If the association execution runs successfully, then the association is COMPLIANT
. If the
association execution doesn't run successfully, the association is NON-COMPLIANT
.
In MANUAL
mode, you must specify the AssociationId
as a parameter for the
PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a
capability of Amazon Web Services Systems Manager. It is managed by your direct call to the
PutComplianceItems API operation.
By default, all associations use AUTO
mode.
syncCompliance
- The mode for generating association compliance. You can specify AUTO
or MANUAL
.
In AUTO
mode, the system uses the status of the association execution to determine the
compliance status. If the association execution runs successfully, then the association is
COMPLIANT
. If the association execution doesn't run successfully, the association is
NON-COMPLIANT
.
In MANUAL
mode, you must specify the AssociationId
as a parameter for the
PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a
capability of Amazon Web Services Systems Manager. It is managed by your direct call to the
PutComplianceItems API operation.
By default, all associations use AUTO
mode.
AssociationSyncCompliance
public CreateAssociationBatchRequestEntry withSyncCompliance(AssociationSyncCompliance syncCompliance)
The mode for generating association compliance. You can specify AUTO
or MANUAL
. In
AUTO
mode, the system uses the status of the association execution to determine the compliance
status. If the association execution runs successfully, then the association is COMPLIANT
. If the
association execution doesn't run successfully, the association is NON-COMPLIANT
.
In MANUAL
mode, you must specify the AssociationId
as a parameter for the
PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a
capability of Amazon Web Services Systems Manager. It is managed by your direct call to the
PutComplianceItems API operation.
By default, all associations use AUTO
mode.
syncCompliance
- The mode for generating association compliance. You can specify AUTO
or MANUAL
.
In AUTO
mode, the system uses the status of the association execution to determine the
compliance status. If the association execution runs successfully, then the association is
COMPLIANT
. If the association execution doesn't run successfully, the association is
NON-COMPLIANT
.
In MANUAL
mode, you must specify the AssociationId
as a parameter for the
PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a
capability of Amazon Web Services Systems Manager. It is managed by your direct call to the
PutComplianceItems API operation.
By default, all associations use AUTO
mode.
AssociationSyncCompliance
public void setApplyOnlyAtCronInterval(Boolean applyOnlyAtCronInterval)
By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.
applyOnlyAtCronInterval
- By default, when you create a new associations, the system runs it immediately after it is created and
then according to the schedule you specified. Specify this option if you don't want an association to run
immediately after you create it. This parameter isn't supported for rate expressions.public Boolean getApplyOnlyAtCronInterval()
By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.
public CreateAssociationBatchRequestEntry withApplyOnlyAtCronInterval(Boolean applyOnlyAtCronInterval)
By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.
applyOnlyAtCronInterval
- By default, when you create a new associations, the system runs it immediately after it is created and
then according to the schedule you specified. Specify this option if you don't want an association to run
immediately after you create it. This parameter isn't supported for rate expressions.public Boolean isApplyOnlyAtCronInterval()
By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.
public List<String> getCalendarNames()
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
public void setCalendarNames(Collection<String> calendarNames)
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
calendarNames
- The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are
gated under. The associations only run when that Change Calendar is open. For more information, see Amazon
Web Services Systems Manager Change Calendar.public CreateAssociationBatchRequestEntry withCalendarNames(String... calendarNames)
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
NOTE: This method appends the values to the existing list (if any). Use
setCalendarNames(java.util.Collection)
or withCalendarNames(java.util.Collection)
if you want
to override the existing values.
calendarNames
- The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are
gated under. The associations only run when that Change Calendar is open. For more information, see Amazon
Web Services Systems Manager Change Calendar.public CreateAssociationBatchRequestEntry withCalendarNames(Collection<String> calendarNames)
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
calendarNames
- The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are
gated under. The associations only run when that Change Calendar is open. For more information, see Amazon
Web Services Systems Manager Change Calendar.public List<TargetLocation> getTargetLocations()
Use this action to create an association in multiple Regions and multiple accounts.
public void setTargetLocations(Collection<TargetLocation> targetLocations)
Use this action to create an association in multiple Regions and multiple accounts.
targetLocations
- Use this action to create an association in multiple Regions and multiple accounts.public CreateAssociationBatchRequestEntry withTargetLocations(TargetLocation... targetLocations)
Use this action to create an association in multiple Regions and multiple accounts.
NOTE: This method appends the values to the existing list (if any). Use
setTargetLocations(java.util.Collection)
or withTargetLocations(java.util.Collection)
if you
want to override the existing values.
targetLocations
- Use this action to create an association in multiple Regions and multiple accounts.public CreateAssociationBatchRequestEntry withTargetLocations(Collection<TargetLocation> targetLocations)
Use this action to create an association in multiple Regions and multiple accounts.
targetLocations
- Use this action to create an association in multiple Regions and multiple accounts.public void setScheduleOffset(Integer scheduleOffset)
Number of days to wait after the scheduled day to run an association.
scheduleOffset
- Number of days to wait after the scheduled day to run an association.public Integer getScheduleOffset()
Number of days to wait after the scheduled day to run an association.
public CreateAssociationBatchRequestEntry withScheduleOffset(Integer scheduleOffset)
Number of days to wait after the scheduled day to run an association.
scheduleOffset
- Number of days to wait after the scheduled day to run an association.public void setDuration(Integer duration)
The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.
The Duration
parameter applies only when both these conditions are true:
The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.
The command specifies the
ApplyOnlyAtCronInterval
parameter, which means that the association doesn't run immediately after it is created, but only according to
the specified schedule.
duration
- The number of hours the association can run before it is canceled. Duration applies to associations that
are currently running, and any pending and in progress commands on all targets. If a target was taken
offline for the association to run, it is made available again immediately, without a reboot.
The Duration
parameter applies only when both these conditions are true:
The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.
The command specifies the
ApplyOnlyAtCronInterval
parameter, which means that the association doesn't run immediately after it is created, but only
according to the specified schedule.
public Integer getDuration()
The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.
The Duration
parameter applies only when both these conditions are true:
The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.
The command specifies the
ApplyOnlyAtCronInterval
parameter, which means that the association doesn't run immediately after it is created, but only according to
the specified schedule.
The Duration
parameter applies only when both these conditions are true:
The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.
The command specifies the
ApplyOnlyAtCronInterval
parameter, which means that the association doesn't run immediately after it is created, but only
according to the specified schedule.
public CreateAssociationBatchRequestEntry withDuration(Integer duration)
The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.
The Duration
parameter applies only when both these conditions are true:
The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.
The command specifies the
ApplyOnlyAtCronInterval
parameter, which means that the association doesn't run immediately after it is created, but only according to
the specified schedule.
duration
- The number of hours the association can run before it is canceled. Duration applies to associations that
are currently running, and any pending and in progress commands on all targets. If a target was taken
offline for the association to run, it is made available again immediately, without a reboot.
The Duration
parameter applies only when both these conditions are true:
The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.
The command specifies the
ApplyOnlyAtCronInterval
parameter, which means that the association doesn't run immediately after it is created, but only
according to the specified schedule.
public List<Map<String,List<String>>> getTargetMaps()
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
public void setTargetMaps(Collection<Map<String,List<String>>> targetMaps)
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
targetMaps
- A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be
specified together.public CreateAssociationBatchRequestEntry withTargetMaps(Map<String,List<String>>... targetMaps)
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
NOTE: This method appends the values to the existing list (if any). Use
setTargetMaps(java.util.Collection)
or withTargetMaps(java.util.Collection)
if you want to
override the existing values.
targetMaps
- A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be
specified together.public CreateAssociationBatchRequestEntry withTargetMaps(Collection<Map<String,List<String>>> targetMaps)
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
targetMaps
- A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be
specified together.public void setAlarmConfiguration(AlarmConfiguration alarmConfiguration)
alarmConfiguration
- public AlarmConfiguration getAlarmConfiguration()
public CreateAssociationBatchRequestEntry withAlarmConfiguration(AlarmConfiguration alarmConfiguration)
alarmConfiguration
- 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.