Package software.amazon.awssdk.services.ssm.model

Class AttachmentsSource

    • Method Detail

      • key

        public final AttachmentsSourceKey key()

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

        If the service returns an enum value that is not available in the current SDK version, key will return AttachmentsSourceKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAsString().

        Returns:
        The key of a key-value pair that identifies the location of an attachment to a document.
        See Also:
        AttachmentsSourceKey

      • keyAsString

        public final String keyAsString()

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

        If the service returns an enum value that is not available in the current SDK version, key will return AttachmentsSourceKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAsString().

        Returns:
        The key of a key-value pair that identifies the location of an attachment to a document.
        See Also:
        AttachmentsSourceKey

      • hasValues

        public final boolean hasValues()
        For responses, this returns true if the service returned a value for the Values property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • values

        public final List<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://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" ]

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasValues() method.

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

      • name

        public final String name()

        The name of the document attachment file.

        Returns:
        The name of the document attachment file.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)