Interface AttachmentsSource.Builder

All Superinterfaces:
Buildable, CopyableBuilder<AttachmentsSource.Builder,AttachmentsSource>, SdkBuilder<AttachmentsSource.Builder,AttachmentsSource>, SdkPojo
Enclosing class:
AttachmentsSource
public static interface AttachmentsSource.Builder extends SdkPojo, CopyableBuilder<AttachmentsSource.Builder,AttachmentsSource>

  • Method Details

    • key

      AttachmentsSource.Builder key(String key)

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

      Parameters:
      key - The key of a key-value pair that identifies the location of an attachment to a document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • key

      AttachmentsSource.Builder key(AttachmentsSourceKey key)

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

      Parameters:
      key - The key of a key-value pair that identifies the location of an attachment to a document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • values

      AttachmentsSource.Builder values(Collection<String> 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://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" ]

      Parameters:
      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://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" ]

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • values

      AttachmentsSource.Builder values(String... 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://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" ]

      Parameters:
      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://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" ]

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      AttachmentsSource.Builder name(String name)

      The name of the document attachment file.

      Parameters:
      name - The name of the document attachment file.
      Returns:
      Returns a reference to this object so that method calls can be chained together.