@Generated(value="software.amazon.awssdk:codegen") public final class CreateAssociationBatchRequestEntry extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CreateAssociationBatchRequestEntry.Builder,CreateAssociationBatchRequestEntry>
Describes the association of a Systems Manager SSM document and an instance.
Modifier and Type | Class and Description |
---|---|
static interface |
CreateAssociationBatchRequestEntry.Builder |
Modifier and Type | Method and Description |
---|---|
String |
associationName()
Specify a descriptive name for the association.
|
static CreateAssociationBatchRequestEntry.Builder |
builder() |
AssociationComplianceSeverity |
complianceSeverity()
The severity level to assign to the association.
|
String |
complianceSeverityAsString()
The severity level to assign to the association.
|
String |
documentVersion()
The document version.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
instanceId()
The ID of the instance.
|
String |
maxConcurrency()
The maximum number of targets allowed to run the association at the same time.
|
String |
maxErrors()
The number of errors that are allowed before the system stops sending requests to run the association on
additional targets.
|
String |
name()
The name of the configuration document.
|
InstanceAssociationOutputLocation |
outputLocation()
An Amazon S3 bucket where you want to store the results of this request.
|
Map<String,List<String>> |
parameters()
A description of the parameters for a document.
|
String |
scheduleExpression()
A cron expression that specifies a schedule when the association runs.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateAssociationBatchRequestEntry.Builder> |
serializableBuilderClass() |
List<Target> |
targets()
The instances targeted by the request.
|
CreateAssociationBatchRequestEntry.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public String name()
The name of the configuration document.
public String instanceId()
The ID of the instance.
public Map<String,List<String>> parameters()
A description of the parameters for a document.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String documentVersion()
The document version.
public List<Target> targets()
The instances targeted by the request.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String scheduleExpression()
A cron expression that specifies a schedule when the association runs.
public InstanceAssociationOutputLocation outputLocation()
An Amazon S3 bucket where you want to store the results of this request.
public String associationName()
Specify a descriptive name for the association.
public 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.
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 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 execute an association while Systems Manager is executing 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 execute an association while Systems Manager is executing 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 AssociationComplianceSeverity complianceSeverity()
The severity level to assign to the association.
If the service returns an enum value that is not available in the current SDK version,
complianceSeverity
will return AssociationComplianceSeverity.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from complianceSeverityAsString()
.
AssociationComplianceSeverity
public String complianceSeverityAsString()
The severity level to assign to the association.
If the service returns an enum value that is not available in the current SDK version,
complianceSeverity
will return AssociationComplianceSeverity.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from complianceSeverityAsString()
.
AssociationComplianceSeverity
public CreateAssociationBatchRequestEntry.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateAssociationBatchRequestEntry.Builder,CreateAssociationBatchRequestEntry>
public static CreateAssociationBatchRequestEntry.Builder builder()
public static Class<? extends CreateAssociationBatchRequestEntry.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.