AWS SDK for C++  1.9.105
AWS SDK for C++
Public Member Functions | List of all members
Aws::SSM::Model::AttachmentsSource Class Reference

#include <AttachmentsSource.h>

Public Member Functions

 AttachmentsSource ()
 
 AttachmentsSource (Aws::Utils::Json::JsonView jsonValue)
 
AttachmentsSourceoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const AttachmentsSourceKeyGetKey () const
 
bool KeyHasBeenSet () const
 
void SetKey (const AttachmentsSourceKey &value)
 
void SetKey (AttachmentsSourceKey &&value)
 
AttachmentsSourceWithKey (const AttachmentsSourceKey &value)
 
AttachmentsSourceWithKey (AttachmentsSourceKey &&value)
 
const Aws::Vector< Aws::String > & GetValues () const
 
bool ValuesHasBeenSet () const
 
void SetValues (const Aws::Vector< Aws::String > &value)
 
void SetValues (Aws::Vector< Aws::String > &&value)
 
AttachmentsSourceWithValues (const Aws::Vector< Aws::String > &value)
 
AttachmentsSourceWithValues (Aws::Vector< Aws::String > &&value)
 
AttachmentsSourceAddValues (const Aws::String &value)
 
AttachmentsSourceAddValues (Aws::String &&value)
 
AttachmentsSourceAddValues (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
AttachmentsSourceWithName (const Aws::String &value)
 
AttachmentsSourceWithName (Aws::String &&value)
 
AttachmentsSourceWithName (const char *value)
 

Detailed Description

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

Definition at line 35 of file AttachmentsSource.h.

Constructor & Destructor Documentation

◆ AttachmentsSource() [1/2]

Aws::SSM::Model::AttachmentsSource::AttachmentsSource ( )

◆ AttachmentsSource() [2/2]

Aws::SSM::Model::AttachmentsSource::AttachmentsSource ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddValues() [1/3]

AttachmentsSource& Aws::SSM::Model::AttachmentsSource::AddValues ( Aws::String &&  value)
inline

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

Definition at line 239 of file AttachmentsSource.h.

◆ AddValues() [2/3]

AttachmentsSource& Aws::SSM::Model::AttachmentsSource::AddValues ( const Aws::String value)
inline

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

Definition at line 219 of file AttachmentsSource.h.

◆ AddValues() [3/3]

AttachmentsSource& Aws::SSM::Model::AttachmentsSource::AddValues ( const char *  value)
inline

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

Definition at line 259 of file AttachmentsSource.h.

◆ GetKey()

const AttachmentsSourceKey& Aws::SSM::Model::AttachmentsSource::GetKey ( ) const
inline

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

Definition at line 48 of file AttachmentsSource.h.

◆ GetName()

const Aws::String& Aws::SSM::Model::AttachmentsSource::GetName ( ) const
inline

The name of the document attachment file.

Definition at line 265 of file AttachmentsSource.h.

◆ GetValues()

const Aws::Vector<Aws::String>& Aws::SSM::Model::AttachmentsSource::GetValues ( ) const
inline

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

Definition at line 99 of file AttachmentsSource.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::SSM::Model::AttachmentsSource::Jsonize ( ) const

◆ KeyHasBeenSet()

bool Aws::SSM::Model::AttachmentsSource::KeyHasBeenSet ( ) const
inline

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

Definition at line 54 of file AttachmentsSource.h.

◆ NameHasBeenSet()

bool Aws::SSM::Model::AttachmentsSource::NameHasBeenSet ( ) const
inline

The name of the document attachment file.

Definition at line 270 of file AttachmentsSource.h.

◆ operator=()

AttachmentsSource& Aws::SSM::Model::AttachmentsSource::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetKey() [1/2]

void Aws::SSM::Model::AttachmentsSource::SetKey ( AttachmentsSourceKey &&  value)
inline

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

Definition at line 66 of file AttachmentsSource.h.

◆ SetKey() [2/2]

void Aws::SSM::Model::AttachmentsSource::SetKey ( const AttachmentsSourceKey value)
inline

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

Definition at line 60 of file AttachmentsSource.h.

◆ SetName() [1/3]

void Aws::SSM::Model::AttachmentsSource::SetName ( Aws::String &&  value)
inline

The name of the document attachment file.

Definition at line 280 of file AttachmentsSource.h.

◆ SetName() [2/3]

void Aws::SSM::Model::AttachmentsSource::SetName ( const Aws::String value)
inline

The name of the document attachment file.

Definition at line 275 of file AttachmentsSource.h.

◆ SetName() [3/3]

void Aws::SSM::Model::AttachmentsSource::SetName ( const char *  value)
inline

The name of the document attachment file.

Definition at line 285 of file AttachmentsSource.h.

◆ SetValues() [1/2]

void Aws::SSM::Model::AttachmentsSource::SetValues ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 159 of file AttachmentsSource.h.

◆ SetValues() [2/2]

void Aws::SSM::Model::AttachmentsSource::SetValues ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 139 of file AttachmentsSource.h.

◆ ValuesHasBeenSet()

bool Aws::SSM::Model::AttachmentsSource::ValuesHasBeenSet ( ) const
inline

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

Definition at line 119 of file AttachmentsSource.h.

◆ WithKey() [1/2]

AttachmentsSource& Aws::SSM::Model::AttachmentsSource::WithKey ( AttachmentsSourceKey &&  value)
inline

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

Definition at line 78 of file AttachmentsSource.h.

◆ WithKey() [2/2]

AttachmentsSource& Aws::SSM::Model::AttachmentsSource::WithKey ( const AttachmentsSourceKey value)
inline

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

Definition at line 72 of file AttachmentsSource.h.

◆ WithName() [1/3]

AttachmentsSource& Aws::SSM::Model::AttachmentsSource::WithName ( Aws::String &&  value)
inline

The name of the document attachment file.

Definition at line 295 of file AttachmentsSource.h.

◆ WithName() [2/3]

AttachmentsSource& Aws::SSM::Model::AttachmentsSource::WithName ( const Aws::String value)
inline

The name of the document attachment file.

Definition at line 290 of file AttachmentsSource.h.

◆ WithName() [3/3]

AttachmentsSource& Aws::SSM::Model::AttachmentsSource::WithName ( const char *  value)
inline

The name of the document attachment file.

Definition at line 300 of file AttachmentsSource.h.

◆ WithValues() [1/2]

AttachmentsSource& Aws::SSM::Model::AttachmentsSource::WithValues ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 199 of file AttachmentsSource.h.

◆ WithValues() [2/2]

AttachmentsSource& Aws::SSM::Model::AttachmentsSource::WithValues ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 179 of file AttachmentsSource.h.


The documentation for this class was generated from the following file: