Idem.AWS.S3.BUCKET

Idem.AWS.S3.BUCKET
Idem.AWS.S3.BUCKET
JSON Example
{
    "account": "string",
    "acl": "string",
    "count": 0,
    "create_bucket_configuration": {
        "LocationConstraint": "string"
    },
    "grant_full_control": "string",
    "grant_read": "string",
    "grant_read_acp": "string",
    "grant_write": "string",
    "grant_write_acp": "string",
    "name": "string",
    "object_lock_configuration": {
        "ObjectLockEnabled": "string",
        "Rule": {
            "DefaultRetention": {
                "Days": 0,
                "Mode": "string",
                "Years": 0
            }
        }
    },
    "object_lock_enabled_for_bucket": false,
    "object_ownership": "string",
    "region": "string",
    "resource_id": "string"
}
string
account
Required

The name of the vRA cloud account to use during provisioning

string
acl
Optional

The associated acl for this bucket ('private', 'public-read', 'public-read-write', 'authenticated-read').

integer
count
Optional

The number of resource instances to be created.

object
create_bucket_configuration
Optional

The configuration information for the bucket. Defaults to None. LocationConstraint (str, Optional): Specifies the Region where the bucket will be created. If you don't specify a Region, the bucket is created in the US East (N. Virginia) Region (us-east-1).

string
grant_full_control
Optional

Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

string
grant_read
Optional

Allows grantee to list the objects in the bucket.

string
grant_read_acp
Optional

Allows grantee to read the bucket ACL.

string
grant_write
Optional

Allows grantee to create new objects in the bucket. For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

string
grant_write_acp
Optional

Allows grantee to write the ACL for the applicable bucket.

string
name
Required

An Idem name of the resource.

object
object_lock_configuration
Optional

The Object Lock configuration that you want to apply to the specified bucket.

boolean
object_lock_enabled_for_bucket
Optional

Specifies whether you want S3 Object Lock to be enabled for the new bucket.

string
object_ownership
Optional

The container element for object ownership for a bucket's ownership controls.

  • BucketOwnerPreferred Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with the bucket-owner-full-control canned ACL.
  • ObjectWriter The uploading account will own the object if the object is uploaded with the bucket-owner-full-control canned ACL.
  • BucketOwnerEnforced Access control lists (ACLs) are disabled and no longer affect permissions. The bucket owner automatically owns and has full control over every object in the bucket. The bucket only accepts PUT requests that don't specify an ACL or bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML format.
string
region
Required

vRA cloud account region to use during provisioning

string
resource_id
Optional

AWS S3 Bucket id

object
tags
Optional

dict in the format of {tag-key: tag-value} or List of tags in the format of [{"Key": tag-key, "Value": tag-value}] to associate with the AMI.

  • Key (str): The key name that can be used to look up or retrieve the associated value. For example, Department or Cost Center are common choices.

  • Value (str): The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources, Accounting, and Support. Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values. Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.