bucket_lifecycle#

State module for managing AWS S3 bucket lifecycle configuration.

async idem_aws.states.aws.s3.bucket_lifecycle.present(hub, ctx, name: str, resource_id: str = None, *, bucket: str, lifecycle_configuration: LifecycleConfiguration = None, timeout: Timeout = None) → Dict[str, Any][source]#

Creates a lifecycle configuration for an S3 bucket resource.

Parameters:

name (str) – An Idem name of the resource.
resource_id (str, Optional) – The name of the S3 bucket in Amazon Web Services. It must be equal to the bucket parameter.
bucket (str) – The name of the S3 bucket in Amazon Web Services.
lifecycle_configuration (dict[str, Any], Optional) –
The lifecycle configuration for the S3 bucket. Defaults to None.
- Rules (list[dict[str, Any]]):
  Specifies lifecycle configuration rules for an Amazon S3 bucket.
  - ID (str):
    Unique identifier for the rule. The value can’t be longer than 255 characters.
  - Status (str):
    If Enabled, the rule is currently being applied. If Disabled, the rule is not currently being applied.
  - Filter (dict[str, Any]):
    The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix , Tag , or And specified.
    
    Prefix (str, Optional):
    Prefix identifying one or more objects to which the rule applies.
    
    Tag (dict[str, Any], Optional):
    This tag must exist in the object’s tag set in order for the rule to apply.
    
    Key (str):
    Name of the object key.
    
    Value (str):
    Value of the tag.
    
    ObjectSizeGreaterThan (int, Optional):
    Minimum object size to which the rule applies.
    
    ObjectSizeLessThan (int, Optional):
    Maximum object size to which the rule applies.
    
    And (dict[str, Any], Optional):
    This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates. The Lifecycle Rule will apply to any object matching all of the predicates configured inside the And
    
    operator.
    
    Prefix (str, Optional):
    Prefix identifying one or more objects to which the rule applies.
    
    Tag (dict[str, Any], Optional):
    This tag must exist in the object’s tag set in order for the rule to apply.
    
    Key (str):
    Name of the object key.
    
    Value (str):
    Value of the tag.
    
    ObjectSizeGreaterThan (int, Optional):
    Minimum object size to which the rule applies.
    
    ObjectSizeLessThan (int, Optional):
    Maximum object size to which the rule applies.
  - Expiration (dict[str, Any], Optional):
    Specifies the expiration for the lifecycle of the object.
    
    Date (str, Optional):
    Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.
    
    Days (int, Optional):
    Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.
    
    ExpiredObjectDeleteMarker (bool, Optional):
    Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.
  - Transition (dict[str, Any], Optional):
    Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle in the Amazon S3 User Guide.
    
    Date (str, Optional):
    Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.
    
    Days (int, Optional):
    Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.
    
    StorageClass (str, Optional):
    The storage class to which you want the object to transition.
  - NoncurrentVersionTransition (dict[str, Any], Optional):
    Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage class at a specific period in the object’s lifetime.
    
    NoncurrentDays (int, Optional):
    Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon S3 User Guide.
    
    StorageClass (str, Optional):
    The class of storage used to store the object.
    
    NewerNoncurrentVersions (int, Optional):
    Specifies how many noncurrent versions Amazon S3 will retain. If there are this many more recent noncurrent versions, Amazon S3 will take the associated action. For more information about noncurrent versions, see Lifecycle configuration elements in the Amazon S3 User Guide.
  - NoncurrentVersionExpiration (dict[str, Any], Optional):
    Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object’s lifetime.
    
    NoncurrentDays (int, Optional):
    Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. The value must be a non-zero positive integer. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon S3 User Guide.
    
    NewerNoncurrentVersions (int, Optional):
    Specifies how many noncurrent versions Amazon S3 will retain. If there are this many more recent noncurrent versions, Amazon S3 will take the associated action. For more information about noncurrent versions, see Lifecycle configuration elements in the Amazon S3 User Guide.
  - AbortIncompleteMultipartUpload (dict[str, Any], Optional):
    Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the Amazon S3 User Guide.
    
    DaysAfterInitiation (int, Optional):
    Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload.
timeout (dict, Optional) –
Timeout configuration for S3 bucket lifecycle configuration.
- update (str):
  Timeout configuration for updating the S3 bucket lifecycle configuration.
  - delay (int, Optional):
    The amount of time in seconds to wait between attempts. Defaults to 4 seconds.
  - max_attempts (int, Optional):
    Maximum attempts of waiting for the update. Defaults to 30 attempts.

Request Syntax:

[idem_test_aws_s3_bucket_lifecycle]:
  aws.s3.bucket_lifecycle.present:
    - name: 'str'
    - bucket: 'str'
    - lifecycle_configuration: {'str': []}

Returns:: dict[str, Any]

Examples

idem_test_aws_s3_bucket_lifecycle:
  aws.s3.bucket_lifecycle.present:
    - name: value
    - bucket: value
    - lifecycle_configuration:
        Rules:
        - ID: 'str'
          Status: 'Enabled'
          Filter:
            Prefix: ''
          Expiration:
            Date: datetime(2015, 1, 1)
            Days: 123
            ExpiredObjectDeleteMarker: True
          Transition:
            Date: datetime(2015, 1, 1)
            Days: 123
            StorageClass: 'GLACIER'
          NoncurrentVersionTransitions:
            - NoncurrentDays: 123
              StorageClass: 'GLACIER'
              NewerNoncurrentVersions: 123
          NoncurrentVersionExpiration:
            NoncurrentDays: 123
            NewerNoncurrentVersions: 123
          AbortIncompleteMultipartUpload:
            DaysAfterInitiation: 123

async idem_aws.states.aws.s3.bucket_lifecycle.absent(hub, ctx, name: str, resource_id: str = None, timeout: Dict = None) → Dict[str, Any][source]#

Deletes a lifecycle configuration from an S3 bucket resource.

Parameters:

name (str) – An Idem name of the resource.
resource_id (str, Optional) – The name of the S3 bucket in Amazon Web Services. Idem automatically considers this resource being absent if this field is not specified.
timeout (dict, Optional) –
Timeout configuration for S3 bucket lifecycle configuration.
- delete (str):
  Timeout configuration for deleting the S3 bucket lifecycle configuration.
  - delay (int, Optional):
    The amount of time in seconds to wait between attempts. Defaults to 4 seconds.
  - max_attempts (int, Optional):
    Maximum attempts of waiting for the deletion. Defaults to 30 attempts.

Returns:

dict[str, Any]

Examples

idem_test_aws_s3_bucket_lifecycle:
  aws.s3.bucket_lifecycle.absent:
    - name: value
    - resource_id: value

async idem_aws.states.aws.s3.bucket_lifecycle.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

Describe the resource in a way that can be recreated/managed with the corresponding “present” function.

Gets the lifecycle configuration for each S3 bucket under the given AWS account.

Returns:: dict[str, dict[str, Any]]

Examples

$ idem describe aws.s3.bucket_lifecycle