Class: MintPress::Aws::S3::MultipartUpload

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb

Properties (Read/Write)

  • #acl ⇒ [String]
    'The canned ACL to apply to the object. This action is not supported by Amazon S3 on Outposts.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'acl'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

24
25
26
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 24

property :acl, create_multipart_upload_prop: 'acl', type: [String], read_only: false, source: "create_multipart_upload", description: 'The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.'
  • #bucket ⇒ [String]
    'The name of the bucket to which the multipart upload was initiated. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'bucket'
    • read_only ⇒ false
    • source ⇒ "list_multipart_uploads"
    • list_multipart_uploads_prop ⇒ 'bucket'
    

27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 27

property :bucket, create_multipart_upload_prop: 'bucket', type: [String], read_only: false, source: "list_multipart_uploads", description: 'The name of the bucket to which the multipart upload was initiated.

When using this API with an access point, you must direct requests to
the access point hostname. The access point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
When using this operation with an access point through the AWS SDKs,
you provide the access point ARN in place of the bucket name. For more
information about access point ARNs, see Using Access Points in
the Amazon Simple Storage Service Developer Guide.

When using this API with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this operation using S3 on Outposts through the AWS SDKs,
you provide the Outposts bucket ARN in place of the bucket name. For
more information about S3 on Outposts ARNs, see Using S3 on
Outposts in the Amazon Simple Storage Service Developer Guide.', list_multipart_uploads_prop: 'bucket'
  • #cache_control ⇒ [String]
    'Specifies caching behavior along the request/reply chain.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'cache_control'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

45
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 45

property :cache_control, create_multipart_upload_prop: 'cache_control', type: [String], read_only: false, source: "create_multipart_upload", description: 'Specifies caching behavior along the request/reply chain.'
  • #content_disposition ⇒ [String]
    'Specifies presentational information for the object.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'content_disposition'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

46
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 46

property :content_disposition, create_multipart_upload_prop: 'content_disposition', type: [String], read_only: false, source: "create_multipart_upload", description: 'Specifies presentational information for the object.'
  • #content_encoding ⇒ [String]
    'Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'content_encoding'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

47
48
49
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 47

property :content_encoding, create_multipart_upload_prop: 'content_encoding', type: [String], read_only: false, source: "create_multipart_upload", description: 'Specifies what content encodings have been applied to the object and
thus what decoding mechanisms must be applied to obtain the media-type
referenced by the Content-Type header field.'
  • #content_language ⇒ [String]
    'The language the content is in.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'content_language'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

50
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 50

property :content_language, create_multipart_upload_prop: 'content_language', type: [String], read_only: false, source: "create_multipart_upload", description: 'The language the content is in.'
  • #content_type ⇒ [String]
    'A standard MIME type describing the format of the object data.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'content_type'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

51
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 51

property :content_type, create_multipart_upload_prop: 'content_type', type: [String], read_only: false, source: "create_multipart_upload", description: 'A standard MIME type describing the format of the object data.'
  • #expires ⇒ [Time,DateTime,Integer]
    'The date and time at which the object is no longer cacheable.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'expires'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

52
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 52

property :expires, create_multipart_upload_prop: 'expires', type: [Time,DateTime,Integer], read_only: false, source: "create_multipart_upload", description: 'The date and time at which the object is no longer cacheable.'
  • #grant_full_control ⇒ [String]
    'Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object. This action is not supported by Amazon S3 on Outposts.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'grant_full_control'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

53
54
55
56
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 53

property :grant_full_control, create_multipart_upload_prop: 'grant_full_control', type: [String], read_only: false, source: "create_multipart_upload", description: 'Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the
object.

This action is not supported by Amazon S3 on Outposts.'
  • #grant_read ⇒ [String]
    'Allows grantee to read the object data and its metadata. This action is not supported by Amazon S3 on Outposts.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'grant_read'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

57
58
59
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 57

property :grant_read, create_multipart_upload_prop: 'grant_read', type: [String], read_only: false, source: "create_multipart_upload", description: 'Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.'
  • #grant_read_acp ⇒ [String]
    'Allows grantee to read the object ACL. This action is not supported by Amazon S3 on Outposts.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'grant_read_acp'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

60
61
62
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 60

property :grant_read_acp, create_multipart_upload_prop: 'grant_read_acp', type: [String], read_only: false, source: "create_multipart_upload", description: 'Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.'
  • #grant_write_acp ⇒ [String]
    'Allows grantee to write the ACL for the applicable object. This action is not supported by Amazon S3 on Outposts.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'grant_write_acp'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

63
64
65
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 63

property :grant_write_acp, create_multipart_upload_prop: 'grant_write_acp', type: [String], read_only: false, source: "create_multipart_upload", description: 'Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.'
  • #key ⇒ [String]
    'Key of the object for which the multipart upload was initiated.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'key'
    • disposition ⇒ :read_only_attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::S3::MultipartUpload"
    • orig_name ⇒ 'key'
    

66
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 66

property :key, create_multipart_upload_prop: 'key', type: [String], disposition: :read_only_attribute, read_only: false, source: "MintPress::Aws::S3::MultipartUpload", description: 'Key of the object for which the multipart upload was initiated.', orig_name: 'key'
  • #metadata ⇒ []
    'A map of metadata to store with the object in S3.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'metadata'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

67
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 67

property :metadata, create_multipart_upload_prop: 'metadata', type: [], read_only: false, source: "create_multipart_upload", description: 'A map of metadata to store with the object in S3.'
  • #server_side_encryption ⇒ [String]
    'The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'server_side_encryption'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

68
69
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 68

property :server_side_encryption, create_multipart_upload_prop: 'server_side_encryption', type: [String], read_only: false, source: "create_multipart_upload", description: 'The server-side encryption algorithm used when storing this object in
Amazon S3 (for example, AES256, aws:kms).'
  • #storage_class ⇒ [String]
    'The class of storage used to store the object.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'storage_class'
    • disposition ⇒ :read_only_attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::S3::MultipartUpload"
    • orig_name ⇒ 'storage_class'
    

70
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 70

property :storage_class, create_multipart_upload_prop: 'storage_class', type: [String], disposition: :read_only_attribute, read_only: false, source: "MintPress::Aws::S3::MultipartUpload", description: 'The class of storage used to store the object.', orig_name: 'storage_class'
  • #website_redirect_location ⇒ [String]
    'If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'website_redirect_location'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

71
72
73
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 71

property :website_redirect_location, create_multipart_upload_prop: 'website_redirect_location', type: [String], read_only: false, source: "create_multipart_upload", description: 'If the bucket is configured as a website, redirects requests for this
object to another object in the same bucket or to an external URL.
Amazon S3 stores the value of this header in the object metadata.'
  • #sse_customer_algorithm ⇒ [String]
    'Specifies the algorithm to use to when encrypting the object (for example, AES256).'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'sse_customer_algorithm'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

74
75
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 74

property :sse_customer_algorithm, create_multipart_upload_prop: 'sse_customer_algorithm', type: [String], read_only: false, source: "create_multipart_upload", description: 'Specifies the algorithm to use to when encrypting the object (for
example, AES256).'
  • #sse_customer_key ⇒ [String]
    'Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'sse_customer_key'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

76
77
78
79
80
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 76

property :sse_customer_key, create_multipart_upload_prop: 'sse_customer_key', type: [String], read_only: false, source: "create_multipart_upload", description: 'Specifies the customer-provided encryption key for Amazon S3 to use in
encrypting data. This value is used to store the object and then it is
discarded; Amazon S3 does not store the encryption key. The key must
be appropriate for use with the algorithm specified in the
x-amz-server-side-encryption-customer-algorithm header.'
  • #sse_customer_key_md5 ⇒ [String]
    'Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'sse_customer_key_md5'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

81
82
83
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 81

property :sse_customer_key_md5, create_multipart_upload_prop: 'sse_customer_key_md5', type: [String], read_only: false, source: "create_multipart_upload", description: 'Specifies the 128-bit MD5 digest of the encryption key according to
RFC 1321. Amazon S3 uses this header for a message integrity check to
ensure that the encryption key was transmitted without error.'
  • #ssekms_encryption_context ⇒ [String]
    'Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'ssekms_encryption_context'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

84
85
86
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 84

property :ssekms_encryption_context, create_multipart_upload_prop: 'ssekms_encryption_context', type: [String], read_only: false, source: "create_multipart_upload", description: 'Specifies the AWS KMS Encryption Context to use for object encryption.
The value of this header is a base64-encoded UTF-8 string holding JSON
with the encryption context key-value pairs.'
  • #bucket_key_enabled ⇒ [TrueClass,FalseClass]
    'Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Specifying this header with an object operation doesn’t affect bucket-level settings for S3 Bucket Key.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'bucket_key_enabled'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

87
88
89
90
91
92
93
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 87

property :bucket_key_enabled, create_multipart_upload_prop: 'bucket_key_enabled', type: [TrueClass,FalseClass], read_only: false, source: "create_multipart_upload", description: 'Specifies whether Amazon S3 should use an S3 Bucket Key for object
encryption with server-side encryption using AWS KMS (SSE-KMS).
Setting this header to true causes Amazon S3 to use an S3 Bucket Key
for object encryption with SSE-KMS.

Specifying this header with an object operation doesn’t affect
bucket-level settings for S3 Bucket Key.'
  • #request_payer ⇒ [String]
    'Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 Developer Guide.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'request_payer'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

94
95
96
97
98
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 94

property :request_payer, create_multipart_upload_prop: 'request_payer', type: [String], read_only: false, source: "create_multipart_upload", description: 'Confirms that the requester knows that they will be charged for the
request. Bucket owners need not specify this parameter in their
requests. For information about downloading objects from requester
pays buckets, see Downloading Objects in Requestor Pays Buckets
in the Amazon S3 Developer Guide.'
  • #tagging ⇒ [String]
    'The tag-set for the object. The tag-set must be encoded as URL Query parameters.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'tagging'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

99
100
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 99

property :tagging, create_multipart_upload_prop: 'tagging', type: [String], read_only: false, source: "create_multipart_upload", description: 'The tag-set for the object. The tag-set must be encoded as URL Query
parameters.'
  • #object_lock_mode ⇒ [String]
    'Specifies the Object Lock mode that you want to apply to the uploaded object.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'object_lock_mode'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

101
102
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 101

property :object_lock_mode, create_multipart_upload_prop: 'object_lock_mode', type: [String], read_only: false, source: "create_multipart_upload", description: 'Specifies the Object Lock mode that you want to apply to the uploaded
object.'
  • #object_lock_retain_until_date ⇒ [Time,DateTime,Integer]
    'Specifies the date and time when you want the Object Lock to expire.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'object_lock_retain_until_date'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

103
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 103

property :object_lock_retain_until_date, create_multipart_upload_prop: 'object_lock_retain_until_date', type: [Time,DateTime,Integer], read_only: false, source: "create_multipart_upload", description: 'Specifies the date and time when you want the Object Lock to expire.'
  • #object_lock_legal_hold_status ⇒ [String]
    'Specifies whether you want to apply a Legal Hold to the uploaded object.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'object_lock_legal_hold_status'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

104
105
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 104

property :object_lock_legal_hold_status, create_multipart_upload_prop: 'object_lock_legal_hold_status', type: [String], read_only: false, source: "create_multipart_upload", description: 'Specifies whether you want to apply a Legal Hold to the uploaded
object.'
  • #expected_bucket_owner ⇒ [String]
    'The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'expected_bucket_owner'
    • read_only ⇒ false
    • source ⇒ "list_multipart_uploads"
    • list_multipart_uploads_prop ⇒ 'expected_bucket_owner'
    

106
107
108
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 106

property :expected_bucket_owner, create_multipart_upload_prop: 'expected_bucket_owner', type: [String], read_only: false, source: "list_multipart_uploads", description: 'The account id of the expected bucket owner. If the bucket is owned by
a different account, the request will fail with an HTTP 403 (Access
Denied) error.', list_multipart_uploads_prop: 'expected_bucket_owner'
  • #delimiter ⇒ [String]
    'Character you use to group keys. All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don"t specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.'
    Property Attributes
    • list_multipart_uploads_prop ⇒ 'delimiter'
    • read_only ⇒ false
    • source ⇒ "list_multipart_uploads"
    

112
113
114
115
116
117
118
119
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 112

property :delimiter, list_multipart_uploads_prop: 'delimiter', type: [String], read_only: false, source: "list_multipart_uploads", description: 'Character you use to group keys.

All keys that contain the same string between the prefix, if
specified, and the first occurrence of the delimiter after the prefix
are grouped under a single result element, CommonPrefixes. If you
don"t specify the prefix parameter, then the substring starts at the
beginning of the key. The keys that are grouped under CommonPrefixes
result element are not returned elsewhere in the response.'
  • #encoding_type ⇒ [String]
    'Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.'
    Property Attributes
    • list_multipart_uploads_prop ⇒ 'encoding_type'
    • read_only ⇒ false
    • source ⇒ "list_multipart_uploads"
    

120
121
122
123
124
125
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 120

property :encoding_type, list_multipart_uploads_prop: 'encoding_type', type: [String], read_only: false, source: "list_multipart_uploads", description: 'Requests Amazon S3 to encode the object keys in the response and
specifies the encoding method to use. An object key may contain any
Unicode character; however, XML 1.0 parser cannot parse some
characters, such as characters with an ASCII value from 0 to 10. For
characters that are not supported in XML 1.0, you can add this
parameter to request that Amazon S3 encode the keys in the response.'
  • #key_marker ⇒ [String]
    'Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin. If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list. If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.'
    Property Attributes
    • list_multipart_uploads_prop ⇒ 'key_marker'
    • read_only ⇒ false
    • source ⇒ "list_multipart_uploads"
    

126
127
128
129
130
131
132
133
134
135
136
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 126

property :key_marker, list_multipart_uploads_prop: 'key_marker', type: [String], read_only: false, source: "list_multipart_uploads", description: 'Together with upload-id-marker, this parameter specifies the multipart
upload after which listing should begin.

If upload-id-marker is not specified, only the keys
lexicographically greater than the specified key-marker will be
included in the list.

If upload-id-marker is specified, any multipart uploads for a key
equal to the key-marker might also be included, provided those
multipart uploads have upload IDs lexicographically greater than the
specified upload-id-marker.'
  • #max_uploads ⇒ [Integer]
    'Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.'
    Property Attributes
    • list_multipart_uploads_prop ⇒ 'max_uploads'
    • read_only ⇒ false
    • source ⇒ "list_multipart_uploads"
    

137
138
139
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 137

property :max_uploads, list_multipart_uploads_prop: 'max_uploads', type: [Integer], read_only: false, source: "list_multipart_uploads", description: 'Sets the maximum number of multipart uploads, from 1 to 1,000, to
return in the response body. 1,000 is the maximum number of uploads
that can be returned in a response.'
  • #prefix ⇒ [String]
    'Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you"d use a folder in a file system.)'
    Property Attributes
    • list_multipart_uploads_prop ⇒ 'prefix'
    • read_only ⇒ false
    • source ⇒ "list_multipart_uploads"
    

140
141
142
143
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 140

property :prefix, list_multipart_uploads_prop: 'prefix', type: [String], read_only: false, source: "list_multipart_uploads", description: 'Lists in-progress uploads only for those keys that begin with the
specified prefix. You can use prefixes to separate a bucket into
different grouping of keys. (You can think of using prefix to make
groups in the same way you"d use a folder in a file system.)'
  • #upload_id_marker ⇒ [String]
    'Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.'
    Property Attributes
    • list_multipart_uploads_prop ⇒ 'upload_id_marker'
    • read_only ⇒ false
    • source ⇒ "list_multipart_uploads"
    

144
145
146
147
148
149
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 144

property :upload_id_marker, list_multipart_uploads_prop: 'upload_id_marker', type: [String], read_only: false, source: "list_multipart_uploads", description: 'Together with key-marker, specifies the multipart upload after which
listing should begin. If key-marker is not specified, the
upload-id-marker parameter is ignored. Otherwise, any multipart
uploads for a key equal to the key-marker might be included in the
list only if they have an upload ID lexicographically greater than the
specified upload-id-marker.'
  • #object ⇒ [MintPress::Aws::S3::Object] (Default Value: MintPress::Aws::S3::Object.new)

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "MintPress::Aws::S3::MultipartUpload"
    • orig_name ⇒ 'object'
    • default ⇒ MintPress::Aws::S3::Object.new
    

153
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 153

property :object, disposition: :association, source: "MintPress::Aws::S3::MultipartUpload", orig_name: 'object', type: [MintPress::Aws::S3::Object], default: MintPress::Aws::S3::Object.new
  • #part ⇒ [MintPress::Aws::S3::MultipartUploadPart] (Default Value: MintPress::Aws::S3::MultipartUploadPart.new)

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "MintPress::Aws::S3::MultipartUpload"
    • orig_name ⇒ 'part'
    • default ⇒ MintPress::Aws::S3::MultipartUploadPart.new
    

154
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 154

property :part, disposition: :association, source: "MintPress::Aws::S3::MultipartUpload", orig_name: 'part', type: [MintPress::Aws::S3::MultipartUploadPart], default: MintPress::Aws::S3::MultipartUploadPart.new
  • #parts ⇒ Hash of ⇒ [MintPress::Aws::S3::MultipartUploadPart]

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "MintPress::Aws::S3::MultipartUpload"
    • orig_name ⇒ 'parts'
    

155
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 155

property :parts, disposition: :association, source: "MintPress::Aws::S3::MultipartUpload", orig_name: 'parts', type: [MintPress::Aws::S3::MultipartUploadPart], array: false, hash: true
  • #ssekms_key ⇒ [String]
    'Specifies the ID of the symmetric customer managed AWS KMS CMK to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 Developer Guide.'
    Property Attributes
    • create_multipart_upload_prop ⇒ 'ssekms_key_id'
    • read_only ⇒ false
    • source ⇒ "create_multipart_upload"
    

156
157
158
159
160
161
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 156

property :ssekms_key, create_multipart_upload_prop: 'ssekms_key_id', type: [String], read_only: false, source: "create_multipart_upload", description: 'Specifies the ID of the symmetric customer managed AWS KMS CMK to use
for object encryption. All GET and PUT requests for an object
protected by AWS KMS will fail if not made via SSL or using SigV4. For
information about configuring using any of the officially supported
AWS SDKs and AWS CLI, see Specifying the Signature Version in Request
Authentication in the Amazon S3 Developer Guide.'
  • #name ⇒ [String]

    Property Attributes 
    

162
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 162

property :name, type: [String]
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

166
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 166

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

169
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 169

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

  • #initiated ⇒ [Time]
    'Date and time at which the multipart upload was initiated.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::S3::MultipartUpload"
    • orig_name ⇒ 'initiated'
    • read_only ⇒ true
    

109
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 109

property :initiated, disposition: :read_only_attribute, description: 'Date and time at which the multipart upload was initiated.', source: "MintPress::Aws::S3::MultipartUpload", orig_name: 'initiated', type: [Time], read_only: true
  • #initiator ⇒ [MintPress::Aws::S3::Initiator] (Default Value: MintPress::Aws::S3::Initiator.new)
    'Identifies who initiated the multipart upload.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::S3::MultipartUpload"
    • orig_name ⇒ 'initiator'
    • default ⇒ MintPress::Aws::S3::Initiator.new
    • read_only ⇒ true
    

110
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 110

property :initiator, disposition: :read_only_attribute, description: 'Identifies who initiated the multipart upload.', source: "MintPress::Aws::S3::MultipartUpload", orig_name: 'initiator', type: [MintPress::Aws::S3::Initiator], default: MintPress::Aws::S3::Initiator.new, read_only: true
  • #owner ⇒ [MintPress::Aws::S3::Owner] (Default Value: MintPress::Aws::S3::Owner.new)
    'Specifies the owner of the object that is part of the multipart upload.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::S3::MultipartUpload"
    • orig_name ⇒ 'owner'
    • default ⇒ MintPress::Aws::S3::Owner.new
    • read_only ⇒ true
    

111
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 111

property :owner, disposition: :read_only_attribute, description: 'Specifies the owner of the object that is part of the multipart upload.', source: "MintPress::Aws::S3::MultipartUpload", orig_name: 'owner', type: [MintPress::Aws::S3::Owner], default: MintPress::Aws::S3::Owner.new, read_only: true
  • #bucket_name ⇒ [String] (Default Value: Proc.new { self.name })

    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::S3::MultipartUpload"
    • orig_name ⇒ 'bucket_name'
    • default ⇒ Proc.new { self.name }
    

150
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 150

property :bucket_name, read_only: true, disposition: :read_only_attribute, source: "MintPress::Aws::S3::MultipartUpload", orig_name: 'bucket_name', type: [String], default: Proc.new { self.name }
  • #id ⇒ [String]
    'Upload ID that identifies the multipart upload.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::S3::MultipartUpload"
    • orig_name ⇒ 'upload_id'
    

151
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 151

property :id, read_only: true, disposition: :read_only_attribute, source: "MintPress::Aws::S3::MultipartUpload", orig_name: 'upload_id', type: [String], description: 'Upload ID that identifies the multipart upload.', array: false, hash: false
  • #object_key ⇒ [String]

    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::S3::MultipartUpload"
    • orig_name ⇒ 'object_key'
    

152
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/multipart_upload.rb', line 152

property :object_key, read_only: true, disposition: :read_only_attribute, source: "MintPress::Aws::S3::MultipartUpload", orig_name: 'object_key', type: [String]

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ MultipartUpload

Returns a new instance of MultipartUpload.

Instance Method Details

#create ⇒ Object

#list ⇒ Object