libZSservicesZSamazonka-ssmZSamazonka-ssm
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SSM.Types.AttachmentsSource

Description

 
Synopsis

Documentation

data AttachmentsSource Source #

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: newAttachmentsSource smart constructor.

Constructors

AttachmentsSource' 

Fields

  • values :: Maybe (NonEmpty Text)

    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" ]
  • key :: Maybe AttachmentsSourceKey

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

  • name :: Maybe Text

    The name of the document attachment file.

Instances

Instances details
Eq AttachmentsSource Source # 
Instance details

Defined in Amazonka.SSM.Types.AttachmentsSource

Read AttachmentsSource Source # 
Instance details

Defined in Amazonka.SSM.Types.AttachmentsSource

Show AttachmentsSource Source # 
Instance details

Defined in Amazonka.SSM.Types.AttachmentsSource

Generic AttachmentsSource Source # 
Instance details

Defined in Amazonka.SSM.Types.AttachmentsSource

Associated Types

type Rep AttachmentsSource :: Type -> Type #

NFData AttachmentsSource Source # 
Instance details

Defined in Amazonka.SSM.Types.AttachmentsSource

Methods

rnf :: AttachmentsSource -> () #

Hashable AttachmentsSource Source # 
Instance details

Defined in Amazonka.SSM.Types.AttachmentsSource

ToJSON AttachmentsSource Source # 
Instance details

Defined in Amazonka.SSM.Types.AttachmentsSource

type Rep AttachmentsSource Source # 
Instance details

Defined in Amazonka.SSM.Types.AttachmentsSource

type Rep AttachmentsSource = D1 ('MetaData "AttachmentsSource" "Amazonka.SSM.Types.AttachmentsSource" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "AttachmentsSource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttachmentsSourceKey)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newAttachmentsSource :: AttachmentsSource Source #

Create a value of AttachmentsSource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:values:AttachmentsSource', attachmentsSource_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" ]

$sel:key:AttachmentsSource', attachmentsSource_key - The key of a key-value pair that identifies the location of an attachment to a document.

$sel:name:AttachmentsSource', attachmentsSource_name - The name of the document attachment file.

attachmentsSource_values :: Lens' AttachmentsSource (Maybe (NonEmpty Text)) Source #

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

attachmentsSource_key :: Lens' AttachmentsSource (Maybe AttachmentsSourceKey) Source #

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

attachmentsSource_name :: Lens' AttachmentsSource (Maybe Text) Source #

The name of the document attachment file.