/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace SSM { namespace Model { /** *

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 Reference

*/ class AttachmentsSource { public: AWS_SSM_API AttachmentsSource(); AWS_SSM_API AttachmentsSource(Aws::Utils::Json::JsonView jsonValue); AWS_SSM_API AttachmentsSource& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_SSM_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

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

*/ inline const AttachmentsSourceKey& GetKey() const{ return m_key; } /** *

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

*/ inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; } /** *

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

*/ inline void SetKey(const AttachmentsSourceKey& value) { m_keyHasBeenSet = true; m_key = value; } /** *

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

*/ inline void SetKey(AttachmentsSourceKey&& value) { m_keyHasBeenSet = true; m_key = std::move(value); } /** *

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

*/ inline AttachmentsSource& WithKey(const AttachmentsSourceKey& value) { SetKey(value); return *this;} /** *

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

*/ inline AttachmentsSource& WithKey(AttachmentsSourceKey&& value) { SetKey(std::move(value)); return *this;} /** *

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

*/ inline const Aws::Vector& GetValues() const{ return m_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" * ]

*/ inline bool ValuesHasBeenSet() const { return m_valuesHasBeenSet; } /** *

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

*/ inline void SetValues(const Aws::Vector& value) { m_valuesHasBeenSet = true; m_values = value; } /** *

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

*/ inline void SetValues(Aws::Vector&& value) { m_valuesHasBeenSet = true; m_values = std::move(value); } /** *

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

*/ inline AttachmentsSource& WithValues(const Aws::Vector& value) { SetValues(value); return *this;} /** *

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

*/ inline AttachmentsSource& WithValues(Aws::Vector&& value) { SetValues(std::move(value)); return *this;} /** *

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

*/ inline AttachmentsSource& AddValues(const Aws::String& value) { m_valuesHasBeenSet = true; m_values.push_back(value); return *this; } /** *

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

*/ inline AttachmentsSource& AddValues(Aws::String&& value) { m_valuesHasBeenSet = true; m_values.push_back(std::move(value)); return *this; } /** *

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

*/ inline AttachmentsSource& AddValues(const char* value) { m_valuesHasBeenSet = true; m_values.push_back(value); return *this; } /** *

The name of the document attachment file.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

The name of the document attachment file.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

The name of the document attachment file.

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

The name of the document attachment file.

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

The name of the document attachment file.

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

The name of the document attachment file.

*/ inline AttachmentsSource& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

The name of the document attachment file.

*/ inline AttachmentsSource& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

The name of the document attachment file.

*/ inline AttachmentsSource& WithName(const char* value) { SetName(value); return *this;} private: AttachmentsSourceKey m_key; bool m_keyHasBeenSet = false; Aws::Vector m_values; bool m_valuesHasBeenSet = false; Aws::String m_name; bool m_nameHasBeenSet = false; }; } // namespace Model } // namespace SSM } // namespace Aws