File: bucket_lifecycle_configuration.rbs

package info (click to toggle)
ruby-aws-sdk-s3 1.170.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,740 kB
  • sloc: ruby: 16,388; makefile: 3
file content (115 lines) | stat: -rw-r--r-- 5,410 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE

module Aws
  module S3
    # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/BucketLifecycleConfiguration.html
    class BucketLifecycleConfiguration
      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/BucketLifecycleConfiguration.html#initialize-instance_method
      def initialize: (String bucket_name, Hash[Symbol, untyped] options) -> void
                    | (bucket_name: String, ?client: Client) -> void
                    | (Hash[Symbol, untyped] args) -> void

      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/BucketLifecycleConfiguration.html#bucket_name-instance_method
      def bucket_name: () -> String

      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/BucketLifecycleConfiguration.html#rules-instance_method
      def rules: () -> ::Array[Types::LifecycleRule]

      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/BucketLifecycleConfiguration.html#transition_default_minimum_object_size-instance_method
      def transition_default_minimum_object_size: () -> ("varies_by_storage_class" | "all_storage_classes_128K")

      def client: () -> Client

      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/BucketLifecycleConfiguration.html#load-instance_method
      def load: () -> self
      alias reload load

      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/BucketLifecycleConfiguration.html#data-instance_method
      def data: () -> Types::GetBucketLifecycleConfigurationOutput

      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/BucketLifecycleConfiguration.html#data_loaded?-instance_method
      def data_loaded?: () -> bool


      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/BucketLifecycleConfiguration.html#delete-instance_method
      def delete: (
                    ?expected_bucket_owner: ::String
                  ) -> ::Aws::EmptyStructure
                | (?Hash[Symbol, untyped]) -> ::Aws::EmptyStructure

      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/BucketLifecycleConfiguration.html#put-instance_method
      def put: (
                 ?checksum_algorithm: ("CRC32" | "CRC32C" | "SHA1" | "SHA256"),
                 ?lifecycle_configuration: {
                   rules: Array[
                     {
                       expiration: {
                         date: ::Time?,
                         days: ::Integer?,
                         expired_object_delete_marker: bool?
                       }?,
                       id: ::String?,
                       prefix: ::String?,
                       filter: {
                         prefix: ::String?,
                         tag: {
                           key: ::String,
                           value: ::String
                         }?,
                         object_size_greater_than: ::Integer?,
                         object_size_less_than: ::Integer?,
                         and: {
                           prefix: ::String?,
                           tags: Array[
                             {
                               key: ::String,
                               value: ::String
                             },
                           ]?,
                           object_size_greater_than: ::Integer?,
                           object_size_less_than: ::Integer?
                         }?
                       }?,
                       status: ("Enabled" | "Disabled"),
                       transitions: Array[
                         {
                           date: ::Time?,
                           days: ::Integer?,
                           storage_class: ("GLACIER" | "STANDARD_IA" | "ONEZONE_IA" | "INTELLIGENT_TIERING" | "DEEP_ARCHIVE" | "GLACIER_IR")?
                         },
                       ]?,
                       noncurrent_version_transitions: Array[
                         {
                           noncurrent_days: ::Integer?,
                           storage_class: ("GLACIER" | "STANDARD_IA" | "ONEZONE_IA" | "INTELLIGENT_TIERING" | "DEEP_ARCHIVE" | "GLACIER_IR")?,
                           newer_noncurrent_versions: ::Integer?
                         },
                       ]?,
                       noncurrent_version_expiration: {
                         noncurrent_days: ::Integer?,
                         newer_noncurrent_versions: ::Integer?
                       }?,
                       abort_incomplete_multipart_upload: {
                         days_after_initiation: ::Integer?
                       }?
                     },
                   ]
                 },
                 ?expected_bucket_owner: ::String,
                 ?transition_default_minimum_object_size: ("varies_by_storage_class" | "all_storage_classes_128K")
               ) -> Types::PutBucketLifecycleConfigurationOutput
             | (?Hash[Symbol, untyped]) -> Types::PutBucketLifecycleConfigurationOutput

      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/BucketLifecycleConfiguration.html#bucket-instance_method
      def bucket: () -> Bucket

      class Collection < ::Aws::Resources::Collection[BucketLifecycleConfiguration]
      end
    end
  end
end