Struct AttachmentsSource

#[non_exhaustive]
pub struct AttachmentsSource {
    pub key: Option<AttachmentsSourceKey>,
    pub values: Option<Vec<String>>,
    pub name: Option<String>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key: Option<AttachmentsSourceKey>

The key of a key-value pair that identifies the location of an attachment to a document.

values: Option<Vec<String>>

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://amzn-s3-demo-bucket/my-prefix" \]

• For the key S3FileUrl, the value is a file in an S3 bucket. For example:

  "Values": \[ "s3://amzn-s3-demo-bucket/my-prefix/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" \]

name: Option<String>

The name of the document attachment file.

Implementations

impl AttachmentsSource

pub fn key(&self) -> Option<&AttachmentsSourceKey>

The key of a key-value pair that identifies the location of an attachment to a document.

pub fn values(&self) -> &[String]

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://amzn-s3-demo-bucket/my-prefix" \]

• For the key S3FileUrl, the value is a file in an S3 bucket. For example:

  "Values": \[ "s3://amzn-s3-demo-bucket/my-prefix/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" \]

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .values.is_none().

pub fn name(&self) -> Option<&str>

The name of the document attachment file.

impl AttachmentsSource

pub fn builder() -> AttachmentsSourceBuilder

Creates a new builder-style object to manufacture AttachmentsSource.

Trait Implementations

impl Clone for AttachmentsSource

fn clone(&self) -> AttachmentsSource

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AttachmentsSource

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for AttachmentsSource

fn eq(&self, other: &AttachmentsSource) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AttachmentsSource