AssociationDescription (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, ToCopyableBuilder<AssociationDescription.Builder,AssociationDescription>

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

Describes the parameters for a document.

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
`String`	`associationId()` The association ID.
`String`	`associationName()` The association name.
`String`	`associationVersion()` The association version.
`static AssociationDescription.Builder`	`builder()`
`Instant`	`date()` The date when the association was made.
`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.
`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.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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.
`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.
`static Class<? extends AssociationDescription.Builder>`	`serializableBuilderClass()`
`AssociationStatus`	`status()` The association status.
`List<Target>`	`targets()` The instances targeted by the request.
`AssociationDescription.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 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.
  - instanceId
```
public String instanceId()
```
    The ID of the instance.
    
    Returns:
    
    The ID of the instance.
  - associationVersion
```
public String associationVersion()
```
    The association version.
    
    Returns:
    
    The association version.
  - date
```
public Instant date()
```
    The date when the association was made.
    
    Returns:
    
    The date when the association was made.
  - lastUpdateAssociationDate
```
public Instant lastUpdateAssociationDate()
```
    The date when the association was last updated.
    
    Returns:
    
    The date when the association was last updated.
  - status
```
public AssociationStatus status()
```
    The association status.
    
    Returns:
    
    The association status.
  - overview
```
public AssociationOverview overview()
```
    Information about the association.
    
    Returns:
    
    Information about the association.
  - documentVersion
```
public String documentVersion()
```
    The document version.
    
    Returns:
    
    The document version.
  - parameters
```
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.
    
    Returns:
    
    A description of the parameters for a document.
  - associationId
```
public String associationId()
```
    The association ID.
    
    Returns:
    
    The association ID.
  - targets
```
public List<Target> targets()
```
    The instances targeted by the request.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The instances targeted by the request.
  - scheduleExpression
```
public 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 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.
  - lastExecutionDate
```
public Instant lastExecutionDate()
```
    The date on which the association was last run.
    
    Returns:
    
    The date on which the association was last run.
  - lastSuccessfulExecutionDate
```
public 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 String associationName()
```
    The association name.
    
    Returns:
    
    The association name.
  - toBuilder
```
public AssociationDescription.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<AssociationDescription.Builder,AssociationDescription>
    
    Returns:
    
    a builder for type T
  - builder
```
public static AssociationDescription.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AssociationDescription.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)
```
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

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

parameters

associationId

targets

scheduleExpression

outputLocation

lastExecutionDate

lastSuccessfulExecutionDate

associationName

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

marshall