AttachmentsSource (AWS Java SDK for the AWS Simple Systems Management (SSM) Service 1.11.871 API)

java.lang.Object
- com.amazonaws.services.simplesystemsmanagement.model.AttachmentsSource

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AttachmentsSource
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Identifying information about a document attachment, including the file name and a key-value pair that identifies the location of an attachment to a document.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AttachmentsSource()

Constructors
Constructor and Description
`AttachmentsSource()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AttachmentsSource`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getKey()` The key of a key-value pair that identifies the location of an attachment to a document.
`String`	`getName()` The name of the document attachment file.
`List<String>`	`getValues()` The value of a key-value pair that identifies the location of an attachment to a document.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setKey(String key)` The key of a key-value pair that identifies the location of an attachment to a document.
`void`	`setName(String name)` The name of the document attachment file.
`void`	`setValues(Collection<String> values)` The value of a key-value pair that identifies the location of an attachment to a document.
`String`	`toString()` Returns a string representation of this object.
`AttachmentsSource`	`withKey(AttachmentsSourceKey key)` The key of a key-value pair that identifies the location of an attachment to a document.
`AttachmentsSource`	`withKey(String key)` The key of a key-value pair that identifies the location of an attachment to a document.
`AttachmentsSource`	`withName(String name)` The name of the document attachment file.
`AttachmentsSource`	`withValues(Collection<String> values)` The value of a key-value pair that identifies the location of an attachment to a document.
`AttachmentsSource`	`withValues(String... values)` The value of a key-value pair that identifies the location of an attachment to a document.

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

- Constructor Detail
  - AttachmentsSource
```
public AttachmentsSource()
```
- Method Detail
  - setKey
```
public void setKey(String key)
```
    The key of a key-value pair that identifies the location of an attachment to a document.
    
    Parameters:
    
    key - The key of a key-value pair that identifies the location of an attachment to a document.
    
    See Also:
    
    AttachmentsSourceKey
  - getKey
```
public String getKey()
```
    The key of a key-value pair that identifies the location of an attachment to a document.
    
    Returns:
    
    The key of a key-value pair that identifies the location of an attachment to a document.
    
    See Also:
    
    AttachmentsSourceKey
  - withKey
```
public AttachmentsSource withKey(String key)
```
    The key of a key-value pair that identifies the location of an attachment to a document.
    
    Parameters:
    
    key - The key of a key-value pair that identifies the location of an attachment to a document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AttachmentsSourceKey
  - withKey
```
public AttachmentsSource withKey(AttachmentsSourceKey key)
```
    The key of a key-value pair that identifies the location of an attachment to a document.
    
    Parameters:
    
    key - The key of a key-value pair that identifies the location of an attachment to a document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AttachmentsSourceKey
  - getValues
```
public List<String> getValues()
```
    The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.
    - For the key SourceUrl, the value is an S3 bucket location. For example:
      
      "Values": [ "s3://doc-example-bucket/my-folder" ]
    - For the key S3FileUrl, the value is a file in an S3 bucket. For example:
      
      "Values": [ "s3://doc-example-bucket/my-folder/my-file.py" ]
    - For the key AttachmentReference, the value is constructed from the name of another SSM document in your account, a version number of that document, and a file attached to that document version that you want to reuse. For example:
      
      "Values": [ "MyOtherDocument/3/my-other-file.py" ]
      
      However, if the SSM document is shared with you from another account, the full SSM document ARN must be specified instead of the document name only. For example:
      
      "Values": [ "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py" ]
    Returns:
    The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.
    
    For the key SourceUrl, the value is an S3 bucket location. For example:
    
    "Values": [ "s3://doc-example-bucket/my-folder" ]
    
    For the key S3FileUrl, the value is a file in an S3 bucket. For example:
    
    "Values": [ "s3://doc-example-bucket/my-folder/my-file.py" ]
    
    For the key AttachmentReference, the value is constructed from the name of another SSM document in your account, a version number of that document, and a file attached to that document version that you want to reuse. For example:
    
    "Values": [ "MyOtherDocument/3/my-other-file.py" ]
    
    However, if the SSM document is shared with you from another account, the full SSM document ARN must be specified instead of the document name only. For example:
    
    "Values": [ "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py" ]
  - setValues
```
public void setValues(Collection<String> values)
```
    The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.
    - For the key SourceUrl, the value is an S3 bucket location. For example:
      
      "Values": [ "s3://doc-example-bucket/my-folder" ]
    - For the key S3FileUrl, the value is a file in an S3 bucket. For example:
      
      "Values": [ "s3://doc-example-bucket/my-folder/my-file.py" ]
    - For the key AttachmentReference, the value is constructed from the name of another SSM document in your account, a version number of that document, and a file attached to that document version that you want to reuse. For example:
      
      "Values": [ "MyOtherDocument/3/my-other-file.py" ]
      
      However, if the SSM document is shared with you from another account, the full SSM document ARN must be specified instead of the document name only. For example:
      
      "Values": [ "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py" ]
    Parameters:
    values - The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.
    
    For the key SourceUrl, the value is an S3 bucket location. For example:
    
    "Values": [ "s3://doc-example-bucket/my-folder" ]
    
    For the key S3FileUrl, the value is a file in an S3 bucket. For example:
    
    "Values": [ "s3://doc-example-bucket/my-folder/my-file.py" ]
    
    For the key AttachmentReference, the value is constructed from the name of another SSM document in your account, a version number of that document, and a file attached to that document version that you want to reuse. For example:
    
    "Values": [ "MyOtherDocument/3/my-other-file.py" ]
    
    However, if the SSM document is shared with you from another account, the full SSM document ARN must be specified instead of the document name only. For example:
    
    "Values": [ "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py" ]
  - withValues
```
public AttachmentsSource withValues(String... values)
```
    The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.
    - For the key SourceUrl, the value is an S3 bucket location. For example:
      
      "Values": [ "s3://doc-example-bucket/my-folder" ]
    - For the key S3FileUrl, the value is a file in an S3 bucket. For example:
      
      "Values": [ "s3://doc-example-bucket/my-folder/my-file.py" ]
    - For the key AttachmentReference, the value is constructed from the name of another SSM document in your account, a version number of that document, and a file attached to that document version that you want to reuse. For example:
      
      "Values": [ "MyOtherDocument/3/my-other-file.py" ]
      
      However, if the SSM document is shared with you from another account, the full SSM document ARN must be specified instead of the document name only. For example:
      
      "Values": [ "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py" ]
    NOTE: This method appends the values to the existing list (if any). Use setValues(java.util.Collection) or withValues(java.util.Collection) if you want to override the existing values.
    Parameters:
    values - The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.
    
    For the key SourceUrl, the value is an S3 bucket location. For example:
    
    "Values": [ "s3://doc-example-bucket/my-folder" ]
    
    For the key S3FileUrl, the value is a file in an S3 bucket. For example:
    
    "Values": [ "s3://doc-example-bucket/my-folder/my-file.py" ]
    
    For the key AttachmentReference, the value is constructed from the name of another SSM document in your account, a version number of that document, and a file attached to that document version that you want to reuse. For example:
    
    "Values": [ "MyOtherDocument/3/my-other-file.py" ]
    
    However, if the SSM document is shared with you from another account, the full SSM document ARN must be specified instead of the document name only. For example:
    
    "Values": [ "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py" ]
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withValues
```
public AttachmentsSource withValues(Collection<String> values)
```
    The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.
    - For the key SourceUrl, the value is an S3 bucket location. For example:
      
      "Values": [ "s3://doc-example-bucket/my-folder" ]
    - For the key S3FileUrl, the value is a file in an S3 bucket. For example:
      
      "Values": [ "s3://doc-example-bucket/my-folder/my-file.py" ]
    - For the key AttachmentReference, the value is constructed from the name of another SSM document in your account, a version number of that document, and a file attached to that document version that you want to reuse. For example:
      
      "Values": [ "MyOtherDocument/3/my-other-file.py" ]
      
      However, if the SSM document is shared with you from another account, the full SSM document ARN must be specified instead of the document name only. For example:
      
      "Values": [ "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py" ]
    Parameters:
    values - The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.
    
    For the key SourceUrl, the value is an S3 bucket location. For example:
    
    "Values": [ "s3://doc-example-bucket/my-folder" ]
    
    For the key S3FileUrl, the value is a file in an S3 bucket. For example:
    
    "Values": [ "s3://doc-example-bucket/my-folder/my-file.py" ]
    
    For the key AttachmentReference, the value is constructed from the name of another SSM document in your account, a version number of that document, and a file attached to that document version that you want to reuse. For example:
    
    "Values": [ "MyOtherDocument/3/my-other-file.py" ]
    
    However, if the SSM document is shared with you from another account, the full SSM document ARN must be specified instead of the document name only. For example:
    
    "Values": [ "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py" ]
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the document attachment file.
    
    Parameters:
    
    name - The name of the document attachment file.
  - getName
```
public String getName()
```
    The name of the document attachment file.
    
    Returns:
    
    The name of the document attachment file.
  - withName
```
public AttachmentsSource withName(String name)
```
    The name of the document attachment file.
    
    Parameters:
    
    name - The name of the document attachment file.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AttachmentsSource clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class AttachmentsSource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AttachmentsSource

Method Detail

setKey

getKey

withKey

withKey

getValues

setValues

withValues

withValues

setName

getName

withName

toString

equals

hashCode

clone

marshall