Class: Ansible::Ruby::Modules::S3_lifecycle

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::S3_lifecycle

Defined in:

lib/ansible/ruby/modules/generated/cloud/amazon/s3_lifecycle.rb

Overview

Manage s3 bucket lifecycle rules in AWS

Instance Method Summary

• #expiration_date ⇒ String^?

  Indicates the lifetime of the objects that are subject to the rule by the date they will expire.

• #expiration_days ⇒ Integer^?

  Indicates the lifetime, in days, of the objects that are subject to the rule.

• #name ⇒ String

  Name of the s3 bucket.

• #noncurrent_version_expiration_days ⇒ Object^?

  Delete noncurrent versions this many days after they become noncurrent.

• #noncurrent_version_storage_class ⇒ :glacier, ...

  Transition noncurrent versions to this storage class.

• #noncurrent_version_transition_days ⇒ Object^?

  Transition noncurrent versions this many days after they become noncurrent.

• #noncurrent_version_transitions ⇒ Object^?

  A list of transition behaviors to be applied to noncurrent versions for the rule.

• #prefix ⇒ String^?

  Prefix identifying one or more objects to which the rule applies.

• #purge_transitions ⇒ Boolean^?

  “Whether to replace all the current transition(s) with the new transition(s).

• #rule_id ⇒ Object^?

  Unique identifier for the rule.

• #state ⇒ :present, ...

  Create or remove the lifecycle rule.

• #status ⇒ :enabled, ...

  If ‘enabled’, the rule is currently being applied.

• #storage_class ⇒ :glacier, ...

  The storage class to transition to.

• #transition_date ⇒ String^?

  Indicates the lifetime of the objects that are subject to the rule by the date they will transition to a different storage class.

• #transition_days ⇒ Integer^?

  Indicates when, in days, an object transitions to a different storage class.

• #transitions ⇒ Array<Hash>, ...

  A list of transition behaviors to be applied to the rule.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#expiration_date ⇒ String^?

Returns Indicates the lifetime of the objects that are subject to the rule by the date they will expire. The value must be ISO-8601 format, the time must be midnight and a GMT timezone must be specified.rn.

Returns:

• (String, nil) —

  Indicates the lifetime of the objects that are subject to the rule by the date they will expire. The value must be ISO-8601 format, the time must be midnight and a GMT timezone must be specified.rn

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_lifecycle.rb', line 16

attribute :expiration_date

#expiration_days ⇒ Integer^?

Returns Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.

Returns:

• (Integer, nil) —

  Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_lifecycle.rb', line 20

attribute :expiration_days

#name ⇒ String

Returns Name of the s3 bucket.

Returns:

• (String) —

  Name of the s3 bucket

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_lifecycle.rb', line 12

attribute :name

#noncurrent_version_expiration_days ⇒ Object^?

Returns Delete noncurrent versions this many days after they become noncurrent.

Returns:

• (Object, nil) —

  Delete noncurrent versions this many days after they become noncurrent

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_lifecycle.rb', line 32

attribute :noncurrent_version_expiration_days

#noncurrent_version_storage_class ⇒ :glacier, ...

Returns Transition noncurrent versions to this storage class.

Returns:

• (:glacier, :onezone_ia, :standard_ia, nil) —

  Transition noncurrent versions to this storage class

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_lifecycle.rb', line 35

attribute :noncurrent_version_storage_class

#noncurrent_version_transition_days ⇒ Object^?

Returns Transition noncurrent versions this many days after they become noncurrent.

Returns:

• (Object, nil) —

  Transition noncurrent versions this many days after they become noncurrent

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_lifecycle.rb', line 39

attribute :noncurrent_version_transition_days

#noncurrent_version_transitions ⇒ Object^?

Returns A list of transition behaviors to be applied to noncurrent versions for the rule. Each storage class may be used only once. Each transition behavior contains these elementsrn I(transition_days)rn I(storage_class)rn.

Returns:

• (Object, nil) —

  A list of transition behaviors to be applied to noncurrent versions for the rule. Each storage class may be used only once. Each transition behavior contains these elementsrn I(transition_days)rn I(storage_class)rn

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_lifecycle.rb', line 42

attribute :noncurrent_version_transitions

#prefix ⇒ String^?

Returns Prefix identifying one or more objects to which the rule applies. If no prefix is specified, the rule will apply to the whole bucket.

Returns:

• (String, nil) —

  Prefix identifying one or more objects to which the rule applies. If no prefix is specified, the rule will apply to the whole bucket.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_lifecycle.rb', line 24

attribute :prefix

#purge_transitions ⇒ Boolean^?

Returns “Whether to replace all the current transition(s) with the new transition(s). When false, the provided transition(s) will be added, replacing transitions with the same storage_class. When true, existing transitions will be removed and replaced with the new transition(s)rn.

Returns:

• (Boolean, nil) —

  “Whether to replace all the current transition(s) with the new transition(s). When false, the provided transition(s) will be added, replacing transitions with the same storage_class. When true, existing transitions will be removed and replaced with the new transition(s)rn

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_lifecycle.rb', line 28

attribute :purge_transitions

#rule_id ⇒ Object^?

Returns Unique identifier for the rule. The value cannot be longer than 255 characters. A unique value for the rule will be generated if no value is provided.

Returns:

• (Object, nil) —

  Unique identifier for the rule. The value cannot be longer than 255 characters. A unique value for the rule will be generated if no value is provided.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_lifecycle.rb', line 45

attribute :rule_id

#state ⇒ :present, ...

Returns Create or remove the lifecycle rule.

Returns:

• (:present, :absent, nil) —

  Create or remove the lifecycle rule

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_lifecycle.rb', line 48

attribute :state

#status ⇒ :enabled, ...

Returns If ‘enabled’, the rule is currently being applied. If ‘disabled’, the rule is not currently being applied.

Returns:

• (:enabled, :disabled, nil) —

  If ‘enabled’, the rule is currently being applied. If ‘disabled’, the rule is not currently being applied.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_lifecycle.rb', line 52

attribute :status

#storage_class ⇒ :glacier, ...

Returns The storage class to transition to. Currently there are two supported values - ‘glacier’, ‘onezone_ia’, or ‘standard_ia’.,The ‘standard_ia’ class is only being available from Ansible version 2.2.

Returns:

• (:glacier, :onezone_ia, :standard_ia, nil) —

  The storage class to transition to. Currently there are two supported values - ‘glacier’, ‘onezone_ia’, or ‘standard_ia’.,The ‘standard_ia’ class is only being available from Ansible version 2.2.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_lifecycle.rb', line 56

attribute :storage_class

#transition_date ⇒ String^?

Returns Indicates the lifetime of the objects that are subject to the rule by the date they will transition to a different storage class. The value must be ISO-8601 format, the time must be midnight and a GMT timezone must be specified. If transition_days is not specified, this parameter is required.“rn.

Returns:

• (String, nil) —

  Indicates the lifetime of the objects that are subject to the rule by the date they will transition to a different storage class. The value must be ISO-8601 format, the time must be midnight and a GMT timezone must be specified. If transition_days is not specified, this parameter is required.“rn

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_lifecycle.rb', line 60

attribute :transition_date

#transition_days ⇒ Integer^?

Returns Indicates when, in days, an object transitions to a different storage class. If transition_date is not specified, this parameter is required.

Returns:

• (Integer, nil) —

  Indicates when, in days, an object transitions to a different storage class. If transition_date is not specified, this parameter is required.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_lifecycle.rb', line 64

attribute :transition_days

#transitions ⇒ Array<Hash>, ...

Returns A list of transition behaviors to be applied to the rule. Each storage class may be used only once. Each transition behavior may contain these elements I(transition_days) I(transition_date) I(storage_class).

Returns:

• (Array<Hash>, Hash, nil) —

  A list of transition behaviors to be applied to the rule. Each storage class may be used only once. Each transition behavior may contain these elements I(transition_days) I(transition_date) I(storage_class)

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_lifecycle.rb', line 68

attribute :transitions