Skip to content

AttachmentsSource

Source code in docs_src/capo_ssm/types/attachments_source.py 
13
14
15
16
17
18
19
20
21
class AttachmentsSource(TypedDict, closed=True):
    key: NotRequired["capo_ssm.types.attachments_source_key.AttachmentsSourceKey"]
    """<p>The key of a key-value pair that identifies the location of an attachment to a document.</p>"""
    values: NotRequired[
        "capo_ssm.types.attachments_source_values.AttachmentsSourceValues"
    ]
    """<p>The value of a key-value pair that identifies the location of an attachment to a document. The format for <b>Value</b> depends on the type of key you specify.</p> <ul> <li> <p>For the key <i>SourceUrl</i>, the value is an S3 bucket location. For example:</p> <p> <code>"Values": [ "s3://amzn-s3-demo-bucket/my-prefix" ]</code> </p> </li> <li> <p>For the key <i>S3FileUrl</i>, the value is a file in an S3 bucket. For example:</p> <p> <code>"Values": [ "s3://amzn-s3-demo-bucket/my-prefix/my-file.py" ]</code> </p> </li> <li> <p>For the key <i>AttachmentReference</i>, 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:</p> <p> <code>"Values": [ "MyOtherDocument/3/my-other-file.py" ]</code> </p> <p>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:</p> <p> <code>"Values": [ "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py" ]</code> </p> </li> </ul>"""
    name: NotRequired["capo_ssm.types.attachment_identifier.AttachmentIdentifier"]
    """<p>The name of the document attachment file.</p>"""

key instance-attribute 

key: NotRequired[AttachmentsSourceKey]

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

name instance-attribute 

name: NotRequired[AttachmentIdentifier]

The name of the document attachment file.

values instance-attribute 

values: NotRequired[AttachmentsSourceValues]

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" ]