AssociationDescription (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.16.69 API)

java.lang.Object
- software.amazon.awssdk.services.ssm.model.AssociationDescription

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<AssociationDescription.Builder,AssociationDescription>

@Generated(value="software.amazon.awssdk:codegen")
public final class AssociationDescription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AssociationDescription.Builder,AssociationDescription>

Describes the parameters for a document.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AssociationDescription.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AssociationDescription.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`String`	`associationId()` The association ID.
`String`	`associationName()` The association name.
`String`	`associationVersion()` The association version.
`String`	`automationTargetParameterName()` Specify the target for the association.
`static AssociationDescription.Builder`	`builder()`
`List<String>`	`calendarNames()` The names or Amazon Resource Names (ARNs) of the Systems Manager Change Calendar type documents your associations are gated under.
`AssociationComplianceSeverity`	`complianceSeverity()` The severity level that is assigned to the association.
`String`	`complianceSeverityAsString()` The severity level that is assigned to the association.
`Instant`	`date()` The date when the association was made.
`String`	`documentVersion()` The document version.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCalendarNames()` Returns true if the CalendarNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasParameters()` Returns true if the Parameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTargetLocations()` Returns true if the TargetLocations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTargets()` Returns true if the Targets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`instanceId()` The ID of the instance.
`Instant`	`lastExecutionDate()` The date on which the association was last run.
`Instant`	`lastSuccessfulExecutionDate()` The last date on which the association was successfully run.
`Instant`	`lastUpdateAssociationDate()` The date when the association was last updated.
`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 S3 bucket where you want to store the output details of the request.
`AssociationOverview`	`overview()` Information about the association.
`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 AssociationDescription.Builder>`	`serializableBuilderClass()`
`AssociationStatus`	`status()` The association status.
`AssociationSyncCompliance`	`syncCompliance()` The mode for generating association compliance.
`String`	`syncComplianceAsString()` The mode for generating association compliance.
`List<TargetLocation>`	`targetLocations()` The combination of AWS Regions and AWS accounts where you want to run the association.
`List<Target>`	`targets()` The instances targeted by the request.
`AssociationDescription.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - name
```
public final String name()
```
    The name of the Systems Manager document.
    
    Returns:
    
    The name of the Systems Manager document.
  - instanceId
```
public final String instanceId()
```
    The ID of the instance.
    
    Returns:
    
    The ID of the instance.
  - associationVersion
```
public final String associationVersion()
```
    The association version.
    
    Returns:
    
    The association version.
  - date
```
public final Instant date()
```
    The date when the association was made.
    
    Returns:
    
    The date when the association was made.
  - lastUpdateAssociationDate
```
public final Instant lastUpdateAssociationDate()
```
    The date when the association was last updated.
    
    Returns:
    
    The date when the association was last updated.
  - status
```
public final AssociationStatus status()
```
    The association status.
    
    Returns:
    
    The association status.
  - overview
```
public final AssociationOverview overview()
```
    Information about the association.
    
    Returns:
    
    Information about the association.
  - documentVersion
```
public final String documentVersion()
```
    The document version.
    
    Returns:
    
    The document version.
  - automationTargetParameterName
```
public final 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.
    
    Returns:
    
    Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
  - hasParameters
```
public final boolean hasParameters()
```
    Returns true if the Parameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - parameters
```
public final 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.
    
    You can use hasParameters() to see if a value was sent in this field.
    
    Returns:
    
    A description of the parameters for a document.
  - associationId
```
public final String associationId()
```
    The association ID.
    
    Returns:
    
    The association ID.
  - hasTargets
```
public final boolean hasTargets()
```
    Returns true if the Targets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - targets
```
public final List<Target> targets()
```
    The instances targeted by the request.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTargets() to see if a value was sent in this field.
    
    Returns:
    
    The instances targeted by the request.
  - scheduleExpression
```
public final String scheduleExpression()
```
    A cron expression that specifies a schedule when the association runs.
    
    Returns:
    
    A cron expression that specifies a schedule when the association runs.
  - outputLocation
```
public final InstanceAssociationOutputLocation outputLocation()
```
    An S3 bucket where you want to store the output details of the request.
    
    Returns:
    
    An S3 bucket where you want to store the output details of the request.
  - lastExecutionDate
```
public final Instant lastExecutionDate()
```
    The date on which the association was last run.
    
    Returns:
    
    The date on which the association was last run.
  - lastSuccessfulExecutionDate
```
public final Instant lastSuccessfulExecutionDate()
```
    The last date on which the association was successfully run.
    
    Returns:
    
    The last date on which the association was successfully run.
  - associationName
```
public final String associationName()
```
    The association name.
    
    Returns:
    
    The association name.
  - maxErrors
```
public final 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 final 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.
    
    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 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.
  - complianceSeverity
```
public final AssociationComplianceSeverity complianceSeverity()
```
    The severity level that is assigned 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 that is assigned to the association.
    
    See Also:
    
    AssociationComplianceSeverity
  - complianceSeverityAsString
```
public final String complianceSeverityAsString()
```
    The severity level that is assigned 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 that is assigned to the association.
    
    See Also:
    
    AssociationComplianceSeverity
  - syncCompliance
```
public final 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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.
    
    By default, all associations use AUTO mode.
    
    If the service returns an enum value that is not available in the current SDK version, syncCompliance will return AssociationSyncCompliance.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from syncComplianceAsString().
    
    Returns:
    
    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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.
    
    By default, all associations use AUTO mode.
    
    See Also:
    
    AssociationSyncCompliance
  - syncComplianceAsString
```
public final String syncComplianceAsString()
```
    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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.
    
    By default, all associations use AUTO mode.
    
    If the service returns an enum value that is not available in the current SDK version, syncCompliance will return AssociationSyncCompliance.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from syncComplianceAsString().
    
    Returns:
    
    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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.
    
    By default, all associations use AUTO mode.
    
    See Also:
    
    AssociationSyncCompliance
  - applyOnlyAtCronInterval
```
public final 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 is not supported for rate expressions.
    
    Returns:
    
    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 is not supported for rate expressions.
  - hasCalendarNames
```
public final boolean hasCalendarNames()
```
    Returns true if the CalendarNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - calendarNames
```
public final List<String> calendarNames()
```
    The names or Amazon Resource Names (ARNs) of the Systems Manager Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see AWS Systems Manager Change Calendar.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasCalendarNames() to see if a value was sent in this field.
    
    Returns:
    
    The names or Amazon Resource Names (ARNs) of the Systems Manager Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see AWS Systems Manager Change Calendar.
  - hasTargetLocations
```
public final boolean hasTargetLocations()
```
    Returns true if the TargetLocations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - targetLocations
```
public final List<TargetLocation> targetLocations()
```
    The combination of AWS Regions and AWS accounts where you want to run the association.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTargetLocations() to see if a value was sent in this field.
    
    Returns:
    
    The combination of AWS Regions and AWS accounts where you want to run the association.
  - toBuilder
```
public AssociationDescription.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AssociationDescription.Builder,AssociationDescription>
  - builder
```
public static AssociationDescription.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AssociationDescription.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class AssociationDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

name

instanceId

associationVersion

date

lastUpdateAssociationDate

status

overview

documentVersion

automationTargetParameterName

hasParameters

parameters

associationId

hasTargets

targets

scheduleExpression

outputLocation

lastExecutionDate

lastSuccessfulExecutionDate

associationName

maxErrors

maxConcurrency

complianceSeverity

complianceSeverityAsString

syncCompliance

syncComplianceAsString

applyOnlyAtCronInterval

hasCalendarNames

calendarNames

hasTargetLocations

targetLocations

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields