Class: MintPress::Aws::S3::Object

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

Properties (Read/Write)

  • #bucket ⇒ [MintPress::Aws::S3::Bucket]
    'The name of the bucket containing the objects. 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
    • delete_object_prop'bucket'
    • disposition:association
    • read_onlyfalse
    • source"MintPress::Aws::S3::Object"
    • delete_objects_prop'bucket'
    • get_object_prop'bucket'
    • list_objects_prop'bucket'
    • orig_name'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/object.rb', line 27
    
    property :bucket, delete_object_prop: 'bucket', type: [MintPress::Aws::S3::Bucket], disposition: :association, read_only: false, source: "MintPress::Aws::S3::Object", description: 'The name of the bucket containing the objects.
    
    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.', delete_objects_prop: 'bucket', get_object_prop: 'bucket', list_objects_prop: 'bucket', orig_name: 'bucket'
  • #key ⇒ [String]
    'The name that you assign to an object.'

    Property Attributes
    • delete_object_prop'key'
    • disposition:read_only_attribute
    • read_onlyfalse
    • source"MintPress::Aws::S3::Object"
    • get_object_prop'key'
    • orig_name'key'
    
    
    45
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 45
    
    property :key, delete_object_prop: 'key', type: [String], disposition: :read_only_attribute, read_only: false, source: "MintPress::Aws::S3::Object", description: 'The name that you assign to an object.', get_object_prop: 'key', orig_name: 'key'
  • #mfa ⇒ [String]
    'The concatenation of the authentication device"s serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.'

    Property Attributes
    • delete_object_prop'mfa'
    • read_onlyfalse
    • source"delete_objects"
    • delete_objects_prop'mfa'
    
    
    46
    47
    48
    49
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 46
    
    property :mfa, delete_object_prop: 'mfa', type: [String], read_only: false, source: "delete_objects", description: 'The concatenation of the authentication device"s serial number, a
    space, and the value that is displayed on your authentication device.
    Required to permanently delete a versioned object if versioning is
    configured with MFA delete enabled.', delete_objects_prop: 'mfa'
  • #request_payer ⇒ [String]
    'Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.'

    Property Attributes
    • delete_object_prop'request_payer'
    • read_onlyfalse
    • source"list_objects"
    • delete_objects_prop'request_payer'
    • get_object_prop'request_payer'
    • list_objects_prop'request_payer'
    
    
    50
    51
    52
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 50
    
    property :request_payer, delete_object_prop: 'request_payer', type: [String], read_only: false, source: "list_objects", description: 'Confirms that the requester knows that she or he will be charged for
    the list objects request. Bucket owners need not specify this
    parameter in their requests.', delete_objects_prop: 'request_payer', get_object_prop: 'request_payer', list_objects_prop: 'request_payer'
  • #bypass_governance_retention ⇒ [TrueClass,FalseClass]
    'Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. You must have sufficient permissions to perform this operation.'

    Property Attributes
    • delete_object_prop'bypass_governance_retention'
    • read_onlyfalse
    • source"delete_objects"
    • delete_objects_prop'bypass_governance_retention'
    
    
    53
    54
    55
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 53
    
    property :bypass_governance_retention, delete_object_prop: 'bypass_governance_retention', type: [TrueClass,FalseClass], read_only: false, source: "delete_objects", description: 'Specifies whether you want to delete this object even if it has a
    Governance-type Object Lock in place. You must have sufficient
    permissions to perform this operation.', delete_objects_prop: 'bypass_governance_retention'
  • #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
    • delete_object_prop'expected_bucket_owner'
    • read_onlyfalse
    • source"list_objects"
    • delete_objects_prop'expected_bucket_owner'
    • get_object_prop'expected_bucket_owner'
    • list_objects_prop'expected_bucket_owner'
    
    
    56
    57
    58
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 56
    
    property :expected_bucket_owner, delete_object_prop: 'expected_bucket_owner', type: [String], read_only: false, source: "list_objects", 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.', delete_objects_prop: 'expected_bucket_owner', get_object_prop: 'expected_bucket_owner', list_objects_prop: 'expected_bucket_owner'
  • #delete ⇒ [MintPress::Aws::S3::Delete] (Default Value: MintPress::Aws::S3::Delete.new)
    'Container for the request.'

    Property Attributes
    • delete_objects_prop'delete'
    • defaultMintPress::Aws::S3::Delete.new
    • read_onlyfalse
    • source"delete_objects"
    
    
    59
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 59
    
    property :delete, delete_objects_prop: 'delete', type: [MintPress::Aws::S3::Delete], default: MintPress::Aws::S3::Delete.new, read_only: false, source: "delete_objects", description: 'Container for the request.'
  • #response_target ⇒ []
    'Where to write response data, file path, or IO object.'

    Property Attributes
    • get_object_prop'response_target'
    • read_onlyfalse
    • source"get_object"
    
    
    60
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 60
    
    property :response_target, get_object_prop: 'response_target', type: [], read_only: false, source: "get_object", description: 'Where to write response data, file path, or IO object.'
  • #if_match ⇒ [String]
    'Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).'

    Property Attributes
    • get_object_prop'if_match'
    • read_onlyfalse
    • source"get_object"
    
    
    61
    62
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 61
    
    property :if_match, get_object_prop: 'if_match', type: [String], read_only: false, source: "get_object", description: 'Return the object only if its entity tag (ETag) is the same as the one
    specified, otherwise return a 412 (precondition failed).'
  • #if_modified_since ⇒ [Time,DateTime,Integer]
    'Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).'

    Property Attributes
    • get_object_prop'if_modified_since'
    • read_onlyfalse
    • source"get_object"
    
    
    63
    64
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 63
    
    property :if_modified_since, get_object_prop: 'if_modified_since', type: [Time,DateTime,Integer], read_only: false, source: "get_object", description: 'Return the object only if it has been modified since the specified
    time, otherwise return a 304 (not modified).'
  • #if_none_match ⇒ [String]
    'Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).'

    Property Attributes
    • get_object_prop'if_none_match'
    • read_onlyfalse
    • source"get_object"
    
    
    65
    66
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 65
    
    property :if_none_match, get_object_prop: 'if_none_match', type: [String], read_only: false, source: "get_object", description: 'Return the object only if its entity tag (ETag) is different from the
    one specified, otherwise return a 304 (not modified).'
  • #if_unmodified_since ⇒ [Time,DateTime,Integer]
    'Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).'

    Property Attributes
    • get_object_prop'if_unmodified_since'
    • read_onlyfalse
    • source"get_object"
    
    
    67
    68
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 67
    
    property :if_unmodified_since, get_object_prop: 'if_unmodified_since', type: [Time,DateTime,Integer], read_only: false, source: "get_object", description: 'Return the object only if it has not been modified since the specified
    time, otherwise return a 412 (precondition failed).'
  • #range ⇒ [String]
    'Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35. Amazon S3 doesn"t support retrieving multiple ranges of data per GET request.'

    Property Attributes
    • get_object_prop'range'
    • read_onlyfalse
    • source"get_object"
    
    
    69
    70
    71
    72
    73
    74
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 69
    
    property :range, get_object_prop: 'range', type: [String], read_only: false, source: "get_object", description: 'Downloads the specified range bytes of an object. For more information
    about the HTTP Range header, see
    https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
    
     Amazon S3 doesn"t support retrieving multiple ranges of data per
    GET request.'
  • #response_cache_control ⇒ [String]
    'Sets the Cache-Control header of the response.'

    Property Attributes
    • get_object_prop'response_cache_control'
    • read_onlyfalse
    • source"get_object"
    
    
    75
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 75
    
    property :response_cache_control, get_object_prop: 'response_cache_control', type: [String], read_only: false, source: "get_object", description: 'Sets the Cache-Control header of the response.'
  • #response_content_disposition ⇒ [String]
    'Sets the Content-Disposition header of the response'

    Property Attributes
    • get_object_prop'response_content_disposition'
    • read_onlyfalse
    • source"get_object"
    
    
    76
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 76
    
    property :response_content_disposition, get_object_prop: 'response_content_disposition', type: [String], read_only: false, source: "get_object", description: 'Sets the Content-Disposition header of the response'
  • #response_content_encoding ⇒ [String]
    'Sets the Content-Encoding header of the response.'

    Property Attributes
    • get_object_prop'response_content_encoding'
    • read_onlyfalse
    • source"get_object"
    
    
    77
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 77
    
    property :response_content_encoding, get_object_prop: 'response_content_encoding', type: [String], read_only: false, source: "get_object", description: 'Sets the Content-Encoding header of the response.'
  • #response_content_language ⇒ [String]
    'Sets the Content-Language header of the response.'

    Property Attributes
    • get_object_prop'response_content_language'
    • read_onlyfalse
    • source"get_object"
    
    
    78
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 78
    
    property :response_content_language, get_object_prop: 'response_content_language', type: [String], read_only: false, source: "get_object", description: 'Sets the Content-Language header of the response.'
  • #response_content_type ⇒ [String]
    'Sets the Content-Type header of the response.'

    Property Attributes
    • get_object_prop'response_content_type'
    • read_onlyfalse
    • source"get_object"
    
    
    79
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 79
    
    property :response_content_type, get_object_prop: 'response_content_type', type: [String], read_only: false, source: "get_object", description: 'Sets the Content-Type header of the response.'
  • #response_expires ⇒ [Time,DateTime,Integer]
    'Sets the Expires header of the response.'

    Property Attributes
    • get_object_prop'response_expires'
    • read_onlyfalse
    • source"get_object"
    
    
    80
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 80
    
    property :response_expires, get_object_prop: 'response_expires', type: [Time,DateTime,Integer], read_only: false, source: "get_object", description: 'Sets the Expires header of the response.'
  • #sse_customer_algorithm ⇒ [String]
    'If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.'

    Property Attributes
    • get_object_prop'sse_customer_algorithm'
    • disposition:read_only_attribute
    • read_onlyfalse
    • source"MintPress::Aws::S3::Object"
    • orig_name'sse_customer_algorithm'
    
    
    81
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 81
    
    property :sse_customer_algorithm, get_object_prop: 'sse_customer_algorithm', type: [String], disposition: :read_only_attribute, read_only: false, source: "MintPress::Aws::S3::Object", description: 'If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.', orig_name: 'sse_customer_algorithm'
  • #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
    • get_object_prop'sse_customer_key'
    • read_onlyfalse
    • source"get_object"
    
    
    82
    83
    84
    85
    86
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 82
    
    property :sse_customer_key, get_object_prop: 'sse_customer_key', type: [String], read_only: false, source: "get_object", 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]
    'If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.'

    Property Attributes
    • get_object_prop'sse_customer_key_md5'
    • disposition:read_only_attribute
    • read_onlyfalse
    • source"MintPress::Aws::S3::Object"
    • orig_name'sse_customer_key_md5'
    
    
    87
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 87
    
    property :sse_customer_key_md5, get_object_prop: 'sse_customer_key_md5', type: [String], disposition: :read_only_attribute, read_only: false, source: "MintPress::Aws::S3::Object", description: 'If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.', orig_name: 'sse_customer_key_md5'
  • #part_number ⇒ [Integer]
    'Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a "ranged" GET request for the part specified. Useful for downloading just a part of an object.'

    Property Attributes
    • get_object_prop'part_number'
    • read_onlyfalse
    • source"get_object"
    
    
    88
    89
    90
    91
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 88
    
    property :part_number, get_object_prop: 'part_number', type: [Integer], read_only: false, source: "get_object", description: 'Part number of the object being read. This is a positive integer
    between 1 and 10,000. Effectively performs a "ranged" GET request
    for the part specified. Useful for downloading just a part of an
    object.'
  • #owner ⇒ [MintPress::Aws::S3::Owner] (Default Value: MintPress::Aws::S3::Owner.new)
    'The owner of the object.'

    Property Attributes
    • disposition:attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'owner'
    • defaultMintPress::Aws::S3::Owner.new
    
    
    94
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 94
    
    property :owner, disposition: :attribute, description: 'The owner of the object.', source: "MintPress::Aws::S3::Object", orig_name: 'owner', type: [MintPress::Aws::S3::Owner], default: MintPress::Aws::S3::Owner.new
  • #size ⇒ [Integer]
    'Size in bytes of the object.'

    Property Attributes
    • disposition:attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'size'
    
    
    95
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 95
    
    property :size, disposition: :attribute, description: 'Size in bytes of the object.', source: "MintPress::Aws::S3::Object", orig_name: 'size', type: [Integer]
  • #delimiter ⇒ [String]
    'A delimiter is a character you use to group keys.'

    Property Attributes
    • list_objects_prop'delimiter'
    • read_onlyfalse
    • source"list_objects"
    
    
    97
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 97
    
    property :delimiter, list_objects_prop: 'delimiter', type: [String], read_only: false, source: "list_objects", description: 'A delimiter is a character you use to group keys.'
  • #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_objects_prop'encoding_type'
    • read_onlyfalse
    • source"list_objects"
    
    
    98
    99
    100
    101
    102
    103
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 98
    
    property :encoding_type, list_objects_prop: 'encoding_type', type: [String], read_only: false, source: "list_objects", 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.'
  • #max_keys ⇒ [Integer]
    'Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more.'

    Property Attributes
    • list_objects_prop'max_keys'
    • read_onlyfalse
    • source"list_objects"
    
    
    104
    105
    106
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 104
    
    property :max_keys, list_objects_prop: 'max_keys', type: [Integer], read_only: false, source: "list_objects", description: 'Sets the maximum number of keys returned in the response. By default
    the API returns up to 1,000 key names. The response might contain
    fewer keys but will never contain more.'
  • #prefix ⇒ [String]
    'Limits the response to keys that begin with the specified prefix.'

    Property Attributes
    • list_objects_prop'prefix'
    • read_onlyfalse
    • source"list_objects"
    
    
    107
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 107
    
    property :prefix, list_objects_prop: 'prefix', type: [String], read_only: false, source: "list_objects", description: 'Limits the response to keys that begin with the specified prefix.'
  • #acl ⇒ [MintPress::Aws::S3::ObjectAcl] (Default Value: MintPress::Aws::S3::ObjectAcl.new)

    Property Attributes
    • disposition:association
    • source"MintPress::Aws::S3::Object"
    • orig_name'acl'
    • defaultMintPress::Aws::S3::ObjectAcl.new
    
    
    133
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 133
    
    property :acl, disposition: :association, source: "MintPress::Aws::S3::Object", orig_name: 'acl', type: [MintPress::Aws::S3::ObjectAcl], default: MintPress::Aws::S3::ObjectAcl.new
  • #multipart_upload ⇒ [MintPress::Aws::S3::MultipartUpload] (Default Value: MintPress::Aws::S3::MultipartUpload.new)

    Property Attributes
    • disposition:association
    • source"MintPress::Aws::S3::Object"
    • orig_name'multipart_upload'
    • defaultMintPress::Aws::S3::MultipartUpload.new
    
    
    134
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 134
    
    property :multipart_upload, disposition: :association, source: "MintPress::Aws::S3::Object", orig_name: 'multipart_upload', type: [MintPress::Aws::S3::MultipartUpload], default: MintPress::Aws::S3::MultipartUpload.new
  • #version ⇒ [MintPress::Aws::S3::ObjectVersion] (Default Value: MintPress::Aws::S3::ObjectVersion.new)
    'Version of the object.'

    Property Attributes
    • delete_object_prop'version_id'
    • disposition:association
    • read_onlyfalse
    • source"MintPress::Aws::S3::Object"
    • get_object_prop'version_id'
    • orig_name'version'
    • defaultMintPress::Aws::S3::ObjectVersion.new
    • fromString
    
    
    135
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 135
    
    property :version, delete_object_prop: 'version_id', type: [MintPress::Aws::S3::ObjectVersion], disposition: :association, read_only: false, source: "MintPress::Aws::S3::Object", description: 'Version of the object.', get_object_prop: 'version_id', orig_name: 'version', default: MintPress::Aws::S3::ObjectVersion.new, from: String
  • #name ⇒ [String]

    Property Attributes
    
    
    137
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 137
    
    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
    
    
    141
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 141
    
    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
    • defaultMintPress::InfrastructureAws::AwsPlatform.new
    
    
    144
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 144
    
    property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

  • #etag ⇒ [String]
    'An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.'

    Property Attributes
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'etag'
    • read_onlytrue
    
    
    92
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 92
    
    property :etag, disposition: :read_only_attribute, description: 'An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.', source: "MintPress::Aws::S3::Object", orig_name: 'etag', type: [String], read_only: true
  • #last_modified ⇒ [Time]
    'Last modified date of the object.'

    Property Attributes
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'last_modified'
    • read_onlytrue
    
    
    93
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 93
    
    property :last_modified, disposition: :read_only_attribute, description: 'Last modified date of the object.', source: "MintPress::Aws::S3::Object", orig_name: 'last_modified', type: [Time], read_only: true
  • #storage_class ⇒ [String]
    'Provides storage class information of the object.'

    Property Attributes
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'storage_class'
    • read_onlytrue
    
    
    96
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 96
    
    property :storage_class, disposition: :read_only_attribute, description: 'Provides storage class information of the object.', source: "MintPress::Aws::S3::Object", orig_name: 'storage_class', type: [String], read_only: true
  • #accept_ranges ⇒ [String]
    'Indicates that a range of bytes was specified.'

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'accept_ranges'
    
    
    108
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 108
    
    property :accept_ranges, read_only: true, disposition: :read_only_attribute, description: 'Indicates that a range of bytes was specified.', source: "MintPress::Aws::S3::Object", orig_name: 'accept_ranges', type: [String]
  • #archive_status ⇒ [String]
    'The archive state of the head object.'

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'archive_status'
    
    
    109
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 109
    
    property :archive_status, read_only: true, disposition: :read_only_attribute, description: 'The archive state of the head object.', source: "MintPress::Aws::S3::Object", orig_name: 'archive_status', type: [String]
  • #bucket_key_enabled ⇒ [TrueClass,FalseClass]
    'Indicates whether the object uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).'

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'bucket_key_enabled'
    
    
    110
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 110
    
    property :bucket_key_enabled, read_only: true, disposition: :read_only_attribute, description: 'Indicates whether the object uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).', source: "MintPress::Aws::S3::Object", orig_name: 'bucket_key_enabled', type: [TrueClass,FalseClass]
  • #bucket_name ⇒ [String] (Default Value: Proc.new { self.name })

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'bucket_name'
    • defaultProc.new { self.name }
    
    
    111
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 111
    
    property :bucket_name, read_only: true, disposition: :read_only_attribute, source: "MintPress::Aws::S3::Object", orig_name: 'bucket_name', type: [String], default: Proc.new { self.name }
  • #cache_control ⇒ [String]
    'Specifies caching behavior along the request/reply chain.'

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'cache_control'
    
    
    112
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 112
    
    property :cache_control, read_only: true, disposition: :read_only_attribute, description: 'Specifies caching behavior along the request/reply chain.', source: "MintPress::Aws::S3::Object", orig_name: 'cache_control', type: [String]
  • #content_disposition ⇒ [String]
    'Specifies presentational information for the object.'

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'content_disposition'
    
    
    113
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 113
    
    property :content_disposition, read_only: true, disposition: :read_only_attribute, description: 'Specifies presentational information for the object.', source: "MintPress::Aws::S3::Object", orig_name: 'content_disposition', type: [String]
  • #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
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'content_encoding'
    
    
    114
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 114
    
    property :content_encoding, read_only: true, disposition: :read_only_attribute, 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.', source: "MintPress::Aws::S3::Object", orig_name: 'content_encoding', type: [String]
  • #content_language ⇒ [String]
    'The language the content is in.'

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'content_language'
    
    
    115
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 115
    
    property :content_language, read_only: true, disposition: :read_only_attribute, description: 'The language the content is in.', source: "MintPress::Aws::S3::Object", orig_name: 'content_language', type: [String]
  • #content_length ⇒ [String]
    '(also: #size) Size of the body in bytes.'

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'content_length'
    
    
    116
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 116
    
    property :content_length, read_only: true, disposition: :read_only_attribute, description: '(also: #size)                                      Size of the body in bytes.', source: "MintPress::Aws::S3::Object", orig_name: 'content_length', type: [String]
  • #content_type ⇒ [String]
    'A standard MIME type describing the format of the object data.'

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'content_type'
    
    
    117
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 117
    
    property :content_type, read_only: true, disposition: :read_only_attribute, description: 'A standard MIME type describing the format of the object data.', source: "MintPress::Aws::S3::Object", orig_name: 'content_type', type: [String]
  • #delete_marker ⇒ [TrueClass,FalseClass]
    'Specifies whether the object retrieved was (true) or was not (false) a Delete Marker.'

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'delete_marker'
    
    
    118
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 118
    
    property :delete_marker, read_only: true, disposition: :read_only_attribute, description: 'Specifies whether the object retrieved was (true) or was not (false) a Delete Marker.', source: "MintPress::Aws::S3::Object", orig_name: 'delete_marker', type: [TrueClass,FalseClass]
  • #expiration ⇒ [String]
    'If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header.'

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'expiration'
    
    
    119
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 119
    
    property :expiration, read_only: true, disposition: :read_only_attribute, description: 'If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header.', source: "MintPress::Aws::S3::Object", orig_name: 'expiration', type: [String]
  • #expires ⇒ [Time]
    'The date and time at which the object is no longer cacheable.'

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'expires'
    
    
    120
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 120
    
    property :expires, read_only: true, disposition: :read_only_attribute, description: 'The date and time at which the object is no longer cacheable.', source: "MintPress::Aws::S3::Object", orig_name: 'expires', type: [Time]
  • #expires_string ⇒ [String]

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'expires_string'
    
    
    121
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 121
    
    property :expires_string, read_only: true, disposition: :read_only_attribute, source: "MintPress::Aws::S3::Object", orig_name: 'expires_string', type: [String]
  • #metadata ⇒ []
    'A map of metadata to store with the object in S3.'

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'metadata'
    
    
    122
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 122
    
    property :metadata, read_only: true, disposition: :read_only_attribute, description: 'A map of metadata to store with the object in S3.', source: "MintPress::Aws::S3::Object", orig_name: 'metadata', type: []
  • #missing_meta ⇒ [Integer]
    'This is set to the number of metadata entries not returned in x-amz-meta headers.'

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'missing_meta'
    
    
    123
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 123
    
    property :missing_meta, read_only: true, disposition: :read_only_attribute, description: 'This is set to the number of metadata entries not returned in x-amz-meta headers.', source: "MintPress::Aws::S3::Object", orig_name: 'missing_meta', type: [Integer]
  • #object_lock_legal_hold_status ⇒ [String]
    'Specifies whether a legal hold is in effect for this object.'

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'object_lock_legal_hold_status'
    
    
    124
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 124
    
    property :object_lock_legal_hold_status, read_only: true, disposition: :read_only_attribute, description: 'Specifies whether a legal hold is in effect for this object.', source: "MintPress::Aws::S3::Object", orig_name: 'object_lock_legal_hold_status', type: [String]
  • #object_lock_mode ⇒ [String]
    'The Object Lock mode, if any, that"s in effect for this object.'

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'object_lock_mode'
    
    
    125
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 125
    
    property :object_lock_mode, read_only: true, disposition: :read_only_attribute, description: 'The Object Lock mode, if any, that"s in effect for this object.', source: "MintPress::Aws::S3::Object", orig_name: 'object_lock_mode', type: [String]
  • #object_lock_retain_until_date ⇒ [Time]
    'The date and time when the Object Lock retention period expires.'

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'object_lock_retain_until_date'
    
    
    126
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 126
    
    property :object_lock_retain_until_date, read_only: true, disposition: :read_only_attribute, description: 'The date and time when the Object Lock retention period expires.', source: "MintPress::Aws::S3::Object", orig_name: 'object_lock_retain_until_date', type: [Time]
  • #parts_count ⇒ [Integer]
    'The count of parts this object has.'

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'parts_count'
    
    
    127
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 127
    
    property :parts_count, read_only: true, disposition: :read_only_attribute, description: 'The count of parts this object has.', source: "MintPress::Aws::S3::Object", orig_name: 'parts_count', type: [Integer]
  • #replication_status ⇒ [String]
    'Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.'

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'replication_status'
    
    
    128
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 128
    
    property :replication_status, read_only: true, disposition: :read_only_attribute, description: 'Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.', source: "MintPress::Aws::S3::Object", orig_name: 'replication_status', type: [String]
  • #request_charged ⇒ [String]
    'If present, indicates that the requester was successfully charged for the request.'

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'request_charged'
    
    
    129
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 129
    
    property :request_charged, read_only: true, disposition: :read_only_attribute, description: 'If present, indicates that the requester was successfully charged for the request.', source: "MintPress::Aws::S3::Object", orig_name: 'request_charged', type: [String]
  • #restore ⇒ [String]
    'If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see [RestoreObject][1] or an archive copy is already restored.'

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'restore'
    
    
    130
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 130
    
    property :restore, read_only: true, disposition: :read_only_attribute, description: 'If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see [RestoreObject][1] or an archive copy is already restored.', source: "MintPress::Aws::S3::Object", orig_name: 'restore', type: [String]
  • #server_side_encryption ⇒ [String]
    'If the object is stored using server-side encryption either with an AWS KMS customer master key (CMK) or an Amazon S3-managed encryption key, the response includes this header with the value of the server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).'

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'server_side_encryption'
    
    
    131
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 131
    
    property :server_side_encryption, read_only: true, disposition: :read_only_attribute, description: 'If the object is stored using server-side encryption either with an AWS KMS customer master key (CMK) or an Amazon S3-managed encryption key, the response includes this header with the value of the server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).', source: "MintPress::Aws::S3::Object", orig_name: 'server_side_encryption', type: [String]
  • #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.'

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'website_redirect_location'
    
    
    132
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 132
    
    property :website_redirect_location, read_only: true, disposition: :read_only_attribute, 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.', source: "MintPress::Aws::S3::Object", orig_name: 'website_redirect_location', type: [String]
  • #ssekms_key ⇒ [String]
    'If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.'

    Property Attributes
    • read_onlytrue
    • disposition:read_only_attribute
    • source"MintPress::Aws::S3::Object"
    • orig_name'ssekms_key_id'
    
    
    136
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object.rb', line 136
    
    property :ssekms_key, read_only: true, disposition: :read_only_attribute, description: 'If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.', source: "MintPress::Aws::S3::Object", orig_name: 'ssekms_key_id', 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 = {}) ⇒ Object

Returns a new instance of Object.

Instance Method Details

#deleteObject

#delete_cascadeObject

#getObject

#listObject