Cloud.Service.AWS.S3.Bucket

Cloud.Service.AWS.S3.Bucket
Cloud.Service.AWS.S3.Bucket
JSON Example
{
    "acceleration_status": "string",
    "account": "string",
    "acl": "string",
    "arn": "string",
    "bucket": "string",
    "bucket_domain_name": "string",
    "bucket_prefix": "string",
    "bucket_regional_domain_name": "string",
    "cors_rule": [
        {
            "allowed_headers": [
                "string"
            ],
            "allowed_methods": [
                "string"
            ],
            "allowed_origins": [
                "string"
            ],
            "expose_headers": [
                "string"
            ],
            "max_age_seconds": 0
        }
    ],
    "count": 0,
    "force_destroy": false,
    "hosted_zone_id": "string",
    "lifecycle_rule": [
        {
            "abort_incomplete_multipart_upload_days": 0,
            "enabled": false,
            "expiration": [
                {
                    "date": "string",
                    "days": 0,
                    "expired_object_delete_marker": false
                }
            ],
            "id": "string",
            "noncurrent_version_expiration": [
                {
                    "days": 0
                }
            ],
            "noncurrent_version_transition": [
                {
                    "days": 0,
                    "storage_class": "string"
                }
            ],
            "prefix": "string",
            "transition": [
                {
                    "date": "string",
                    "days": 0,
                    "storage_class": "string"
                }
            ]
        }
    ],
    "logging": [
        {
            "target_bucket": "string",
            "target_prefix": "string"
        }
    ],
    "object_lock_configuration": [
        {
            "object_lock_enabled": "string",
            "rule": [
                {
                    "default_retention": [
                        {
                            "days": 0,
                            "mode": "string",
                            "years": 0
                        }
                    ]
                }
            ]
        }
    ],
    "policy": "string",
    "region": "string",
    "replication_configuration": [
        {
            "role": "string",
            "rules": [
                {
                    "destination": [
                        {
                            "access_control_translation": [
                                {
                                    "owner": "string"
                                }
                            ],
                            "account_id": "string",
                            "bucket": "string",
                            "replica_kms_key_id": "string",
                            "storage_class": "string"
                        }
                    ],
                    "filter": [
                        {
                            "prefix": "string"
                        }
                    ],
                    "id": "string",
                    "prefix": "string",
                    "priority": 0,
                    "source_selection_criteria": [
                        {
                            "sse_kms_encrypted_objects": [
                                {
                                    "enabled": false
                                }
                            ]
                        }
                    ],
                    "status": "string"
                }
            ]
        }
    ],
    "request_payer": "string",
    "server_side_encryption_configuration": [
        {
            "rule": [
                {
                    "apply_server_side_encryption_by_default": [
                        {
                            "kms_master_key_id": "string",
                            "sse_algorithm": "string"
                        }
                    ]
                }
            ]
        }
    ],
    "versioning": [
        {
            "enabled": false,
            "mfa_delete": false
        }
    ],
    "website": [
        {
            "error_document": "string",
            "index_document": "string",
            "redirect_all_requests_to": "string",
            "routing_rules": "string"
        }
    ],
    "website_domain": "string",
    "website_endpoint": "string"
}
string
acceleration_status
Optional

Bucket S3 transition acceleration of Enabled or Suspended.

string
account
Required

(Required) The name of the AWS cloud account to use for this resource

string
acl
Optional

AWS canned access control list (ACL) to apply. Default is private.

string
arn
Optional

ARN of the S3 bucket in arn:aws:s3:::bucketname format.

string
bucket
Optional

User-assigned name for the bucket. If omitted, Cloud Assembly assigns a random, unique name. Forces new resources.

string
bucket_domain_name
Optional

Bucket FQDN in bucketname.s3.amazonaws.com format.

string
bucket_prefix
Optional

User-defined text to add to automatic bucket name. Cannot be used simultaneously with bucket. Forces new resources.

string
bucket_regional_domain_name
Optional

Amazon region domain name. Note: CloudFront allows for region-specific endpoints when creating an S3 origin but might prevent redirects from CloudFront to an S3 origin URL.

array of object
cors_rule
Optional

Settings for cross-origin resource sharing (CORS).

integer
count
Optional

The number of resource instances to be created.

boolean
force_destroy
Optional

Whether to delete all objects in the bucket so that the bucket can be deleted without error. Deleted objects are not recoverable. Default is false.

string
hosted_zone_id
Optional

Route 53 hosted zone identifier for the bucket region endpoint.

array of object
lifecycle_rule
Optional

Settings for lifecycle management.

array of object
logging
Optional

Settings for bucket logging.

array of object
object_lock_configuration
Optional

Settings for S3 Bucket object protection.

string
policy
Optional

Path to a bucket policy JSON document. Use a verbose and specific document when possible.  Even when syntactically valid, a document that lacks detail might cause Cloud Assembly to interpret the policy in unpredictable ways. See the AWS documentation about building IAM policy documents.

string
region
Required

(Required) Target cloud region, such as us-east-1. Must be within the provider cloud account.

array of object
replication_configuration
Optional

Settings for S3 bucket replication.

string
request_payer
Optional

Entity responsible for the cost of S3 data transfer.

array of object
server_side_encryption_configuration
Optional

Settings for server-side encryption, where S3 encrypts an object before saving it to disk in its data centers.

object
tags
Optional

Bucket categorization, in case-sensitive key names, or in key-value pairs.

array of object
versioning
Optional

Settings for versioning the objects in the bucket.

array of object
website
Optional

Settings for the bucket web site.

string
website_domain
Optional

When the bucket is configured for a web site, the domain for the web site. Used to create Route 53 alias records.

string
website_endpoint
Optional

When the bucket is configured for a web site, the endpoint that hosts the site.