software.amazon.awssdk.services.ssm.model

Class CreateAssociationRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssm.model.SsmRequest

software.amazon.awssdk.services.ssm.model.CreateAssociationRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAssociationRequest.Builder,CreateAssociationRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateAssociationRequest
extends SsmRequest
implements ToCopyableBuilder<CreateAssociationRequest.Builder,CreateAssociationRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateAssociationRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	associationName() Specify a descriptive name for the association.
static CreateAssociationRequest.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 you want to associate with the target(s).
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	instanceId() The instance ID.
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 Systems Manager document.
InstanceAssociationOutputLocation	outputLocation() An Amazon S3 bucket where you want to store the output details of the request.
Map<String,List<String>>	parameters() The parameters for the documents runtime configuration.
String	scheduleExpression() A cron expression when the association will be applied to the target(s).
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAssociationRequest.Builder>	serializableBuilderClass()
List<Target>	targets() The targets (either instances or tags) for the association.
CreateAssociationRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public String name()

The name of the Systems Manager document.

Returns:

The name of the Systems Manager document.

documentVersion

public String documentVersion()

The document version you want to associate with the target(s). Can be a specific version or the default version.

Returns:

The document version you want to associate with the target(s). Can be a specific version or the default version.

instanceId

public String instanceId()

The instance ID.

Returns:

The instance ID.

parameters

public Map<String,List<String>> parameters()

The parameters for the documents runtime configuration.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The parameters for the documents runtime configuration.

targets

public List<Target> targets()

The targets (either instances or tags) for the association.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The targets (either instances or tags) for the association.

scheduleExpression

public String scheduleExpression()

A cron expression when the association will be applied to the target(s).

Returns:

A cron expression when the association will be applied to the target(s).

outputLocation

public InstanceAssociationOutputLocation outputLocation()

An Amazon S3 bucket where you want to store the output details of the request.

Returns:

An Amazon S3 bucket where you want to store the output details of the request.

associationName

public String associationName()

Specify a descriptive name for the association.

Returns:

Specify a descriptive name for the association.

maxErrors

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.

Returns:

The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

maxConcurrency

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.

Returns:

The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

If a new instance starts and attempts to 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.

complianceSeverity

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().

Returns:

The severity level to assign to the association.

See Also:

AssociationComplianceSeverity

complianceSeverityAsString

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().

Returns:

The severity level to assign to the association.

See Also:

AssociationComplianceSeverity

toBuilder

public CreateAssociationRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAssociationRequest.Builder,CreateAssociationRequest>

Specified by:

toBuilder in class SsmRequest

Returns:

a builder for type T

builder

public static CreateAssociationRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateAssociationRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.