s3

class pulumi_aws.s3.AccountPublicAccessBlock(resource_name, opts=None, account_id=None, block_public_acls=None, block_public_policy=None, ignore_public_acls=None, restrict_public_buckets=None, __name__=None, __opts__=None)

Manages S3 account-level Public Access Block configuration. For more information about these settings, see the AWS S3 Block Public Access documentation.

NOTE: Each AWS account may only have one S3 Public Access Block configuration. Multiple configurations of the resource against the same AWS account will cause a perpetual difference.

Advanced usage: To use a custom API endpoint for this Terraform resource, use the ``s3control` endpoint provider configuration <https://www.terraform.io/docs/providers/aws/index.html#s3control>`_, not the s3 endpoint provider configuration.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • account_id (pulumi.Input[str]) – AWS account ID to configure. Defaults to automatically determined account ID of the Terraform AWS provider.
  • block_public_acls (pulumi.Input[bool]) – Whether Amazon S3 should block public ACLs for buckets in this account. Defaults to false. Enabling this setting does not affect existing policies or ACLs. When set to true causes the following behavior:
Parameters:block_public_policy (pulumi.Input[bool]) – Whether Amazon S3 should block public bucket policies for buckets in this account. Defaults to false. Enabling this setting does not affect existing bucket policies. When set to true causes Amazon S3 to:
Parameters:ignore_public_acls (pulumi.Input[bool]) – Whether Amazon S3 should ignore public ACLs for buckets in this account. Defaults to false. Enabling this setting does not affect the persistence of any existing ACLs and doesn’t prevent new public ACLs from being set. When set to true causes Amazon S3 to:
Parameters:restrict_public_buckets (pulumi.Input[bool]) – Whether Amazon S3 should restrict public bucket policies for buckets in this account. Defaults to false. Enabling this setting does not affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked. When set to true:
account_id = None

AWS account ID to configure. Defaults to automatically determined account ID of the Terraform AWS provider.

block_public_acls = None

Whether Amazon S3 should block public ACLs for buckets in this account. Defaults to false. Enabling this setting does not affect existing policies or ACLs. When set to true causes the following behavior:

  • PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public access.
  • PUT Object calls will fail if the request includes an object ACL.
block_public_policy = None

Whether Amazon S3 should block public bucket policies for buckets in this account. Defaults to false. Enabling this setting does not affect existing bucket policies. When set to true causes Amazon S3 to:

  • Reject calls to PUT Bucket policy if the specified bucket policy allows public access.
ignore_public_acls = None

Whether Amazon S3 should ignore public ACLs for buckets in this account. Defaults to false. Enabling this setting does not affect the persistence of any existing ACLs and doesn’t prevent new public ACLs from being set. When set to true causes Amazon S3 to:

  • Ignore all public ACLs on buckets in this account and any objects that they contain.
restrict_public_buckets = None

Whether Amazon S3 should restrict public bucket policies for buckets in this account. Defaults to false. Enabling this setting does not affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked. When set to true:

  • Only the bucket owner and AWS Services can access buckets with public policies.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.s3.Bucket(resource_name, opts=None, acceleration_status=None, acl=None, arn=None, bucket=None, bucket_prefix=None, cors_rules=None, force_destroy=None, hosted_zone_id=None, lifecycle_rules=None, loggings=None, object_lock_configuration=None, policy=None, region=None, replication_configuration=None, request_payer=None, server_side_encryption_configuration=None, tags=None, versioning=None, website=None, website_domain=None, website_endpoint=None, __name__=None, __opts__=None)

Provides a S3 bucket resource.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • acceleration_status (pulumi.Input[str]) – Sets the accelerate configuration of an existing bucket. Can be Enabled or Suspended.
  • acl (pulumi.Input[str]) – The canned ACL to apply. Defaults to “private”.
  • arn (pulumi.Input[str]) – The ARN of the bucket. Will be of format arn:aws:s3:::bucketname.
  • bucket (pulumi.Input[str]) – The ARN of the S3 bucket where you want Amazon S3 to store replicas of the object identified by the rule.
  • bucket_prefix (pulumi.Input[str]) – Creates a unique bucket name beginning with the specified prefix. Conflicts with bucket.
  • cors_rules (pulumi.Input[list]) – A rule of Cross-Origin Resource Sharing (documented below).
  • force_destroy (pulumi.Input[bool]) – A boolean that indicates all objects should be deleted from the bucket so that the bucket can be destroyed without error. These objects are not recoverable.
  • hosted_zone_id (pulumi.Input[str]) – The Route 53 Hosted Zone ID for this bucket’s region.
  • lifecycle_rules (pulumi.Input[list]) – A configuration of object lifecycle management (documented below).
  • loggings (pulumi.Input[list]) – A settings of bucket logging (documented below).
  • object_lock_configuration (pulumi.Input[dict]) – A configuration of S3 object locking (documented below)
  • policy (pulumi.Input[str]) – A valid bucket policy JSON document. Note that if the policy document is not specific enough (but still valid), Terraform may view the policy as constantly changing in a terraform plan. In this case, please make sure you use the verbose/specific version of the policy. For more information about building AWS IAM policy documents with Terraform, see the AWS IAM Policy Document Guide.
  • region (pulumi.Input[str]) – If specified, the AWS region this bucket should reside in. Otherwise, the region used by the callee.
  • replication_configuration (pulumi.Input[dict]) – A configuration of replication configuration (documented below).
  • request_payer (pulumi.Input[str]) – Specifies who should bear the cost of Amazon S3 data transfer. Can be either BucketOwner or Requester. By default, the owner of the S3 bucket would incur the costs of any data transfer. See Requester Pays Buckets developer guide for more information.
  • server_side_encryption_configuration (pulumi.Input[dict]) – A configuration of server-side encryption configuration (documented below)
  • tags (pulumi.Input[dict]) – A mapping of tags that identifies subset of objects to which the rule applies. The rule applies only to objects having all the tags in its tagset.
  • versioning (pulumi.Input[dict]) – A state of versioning (documented below)
  • website (pulumi.Input[dict]) – A website object (documented below).
  • website_domain (pulumi.Input[str]) – The domain of the website endpoint, if the bucket is configured with a website. If not, this will be an empty string. This is used to create Route 53 alias records.
  • website_endpoint (pulumi.Input[str]) – The website endpoint, if the bucket is configured with a website. If not, this will be an empty string.
acceleration_status = None

Sets the accelerate configuration of an existing bucket. Can be Enabled or Suspended.

acl = None

The canned ACL to apply. Defaults to “private”.

arn = None

The ARN of the bucket. Will be of format arn:aws:s3:::bucketname.

bucket = None

The ARN of the S3 bucket where you want Amazon S3 to store replicas of the object identified by the rule.

bucket_domain_name = None

The bucket domain name. Will be of format bucketname.s3.amazonaws.com.

bucket_prefix = None

Creates a unique bucket name beginning with the specified prefix. Conflicts with bucket.

bucket_regional_domain_name = None

The bucket region-specific domain name. The bucket domain name including the region name, please refer here for format. Note: The AWS CloudFront allows specifying S3 region-specific endpoint when creating S3 origin, it will prevent redirect issues from CloudFront to S3 Origin URL.

cors_rules = None

A rule of Cross-Origin Resource Sharing (documented below).

force_destroy = None

A boolean that indicates all objects should be deleted from the bucket so that the bucket can be destroyed without error. These objects are not recoverable.

hosted_zone_id = None

The Route 53 Hosted Zone ID for this bucket’s region.

lifecycle_rules = None

A configuration of object lifecycle management (documented below).

loggings = None

A settings of bucket logging (documented below).

object_lock_configuration = None

A configuration of S3 object locking (documented below)

policy = None

A valid bucket policy JSON document. Note that if the policy document is not specific enough (but still valid), Terraform may view the policy as constantly changing in a terraform plan. In this case, please make sure you use the verbose/specific version of the policy. For more information about building AWS IAM policy documents with Terraform, see the AWS IAM Policy Document Guide.

region = None

If specified, the AWS region this bucket should reside in. Otherwise, the region used by the callee.

replication_configuration = None

A configuration of replication configuration (documented below).

request_payer = None

Specifies who should bear the cost of Amazon S3 data transfer. Can be either BucketOwner or Requester. By default, the owner of the S3 bucket would incur the costs of any data transfer. See Requester Pays Buckets developer guide for more information.

server_side_encryption_configuration = None

A configuration of server-side encryption configuration (documented below)

tags = None

A mapping of tags that identifies subset of objects to which the rule applies. The rule applies only to objects having all the tags in its tagset.

versioning = None

A state of versioning (documented below)

website = None

A website object (documented below).

website_domain = None

The domain of the website endpoint, if the bucket is configured with a website. If not, this will be an empty string. This is used to create Route 53 alias records.

website_endpoint = None

The website endpoint, if the bucket is configured with a website. If not, this will be an empty string.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.s3.BucketMetric(resource_name, opts=None, bucket=None, filter=None, name=None, __name__=None, __opts__=None)

Provides a S3 bucket metrics configuration resource.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • bucket (pulumi.Input[str]) – The name of the bucket to put metric configuration.
  • filter (pulumi.Input[dict]) – Object filtering that accepts a prefix, tags, or a logical AND of prefix and tags (documented below).
  • name (pulumi.Input[str]) – Unique identifier of the metrics configuration for the bucket.
bucket = None

The name of the bucket to put metric configuration.

filter = None

Object filtering that accepts a prefix, tags, or a logical AND of prefix and tags (documented below).

name = None

Unique identifier of the metrics configuration for the bucket.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.s3.BucketNotification(resource_name, opts=None, bucket=None, lambda_functions=None, queues=None, topics=None, __name__=None, __opts__=None)

Provides a S3 bucket notification resource.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • bucket (pulumi.Input[str]) – The name of the bucket to put notification configuration.
  • lambda_functions (pulumi.Input[list]) – Used to configure notifications to a Lambda Function (documented below).
  • queues (pulumi.Input[list]) – The notification configuration to SQS Queue (documented below).
  • topics (pulumi.Input[list]) – The notification configuration to SNS Topic (documented below).
bucket = None

The name of the bucket to put notification configuration.

lambda_functions = None

Used to configure notifications to a Lambda Function (documented below).

queues = None

The notification configuration to SQS Queue (documented below).

topics = None

The notification configuration to SNS Topic (documented below).

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.s3.BucketObject(resource_name, opts=None, acl=None, bucket=None, cache_control=None, content=None, content_base64=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None, etag=None, key=None, kms_key_id=None, server_side_encryption=None, source=None, storage_class=None, tags=None, website_redirect=None, __name__=None, __opts__=None)

Provides a S3 bucket object resource.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • acl (pulumi.Input[str]) –

    The canned ACL to apply. Defaults to “private”.

  • bucket (pulumi.Input[str]) – The name of the bucket to put the file in.
  • cache_control (pulumi.Input[str]) – Specifies caching behavior along the request/reply chain Read w3c cache_control for further details.
  • content (pulumi.Input[str]) – Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.
  • content_base64 (pulumi.Input[str]) – Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for small content such as the result of the gzipbase64 function with small text strings. For larger objects, use source to stream the content from a disk file.
  • content_disposition (pulumi.Input[str]) – Specifies presentational information for the object. Read w3c content_disposition for further information.
  • content_encoding (pulumi.Input[str]) – Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. Read w3c content encoding for further information.
  • content_language (pulumi.Input[str]) – The language the content is in e.g. en-US or en-GB.
  • content_type (pulumi.Input[str]) – A standard MIME type describing the format of the object data, e.g. application/octet-stream. All Valid MIME Types are valid for this input.
  • etag (pulumi.Input[str]) – Used to trigger updates. The only meaningful value is ${md5(file("path/to/file"))}. This attribute is not compatible with KMS encryption, kms_key_id or server_side_encryption = "aws:kms".
  • key (pulumi.Input[str]) – The name of the object once it is in the bucket.
  • kms_key_id (pulumi.Input[str]) – Specifies the AWS KMS Key ARN to use for object encryption. This value is a fully qualified ARN of the KMS Key. If using aws_kms_key, use the exported arn attribute: kms_key_id = "${aws_kms_key.foo.arn}"
  • server_side_encryption (pulumi.Input[str]) – Specifies server-side encryption of the object in S3. Valid values are “AES256” and “aws:kms”.
  • source (pulumi.Input[pulumi.Asset]) – The path to a file that will be read and uploaded as raw bytes for the object content.
  • storage_class (pulumi.Input[str]) – Specifies the desired Storage Class for the object. Can be either “STANDARD”, “REDUCED_REDUNDANCY”, “ONEZONE_IA”, “INTELLIGENT_TIERING”, “GLACIER”, or “STANDARD_IA”. Defaults to “STANDARD”.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the object.
  • website_redirect (pulumi.Input[str]) – Specifies a target URL for website redirect.
acl = None

The canned ACL to apply. Defaults to “private”.

bucket = None

The name of the bucket to put the file in.

cache_control = None

Specifies caching behavior along the request/reply chain Read w3c cache_control for further details.

content = None

Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.

content_base64 = None

Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for small content such as the result of the gzipbase64 function with small text strings. For larger objects, use source to stream the content from a disk file.

content_disposition = None

Specifies presentational information for the object. Read w3c content_disposition for further information.

content_encoding = None

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. Read w3c content encoding for further information.

content_language = None

The language the content is in e.g. en-US or en-GB.

content_type = None

A standard MIME type describing the format of the object data, e.g. application/octet-stream. All Valid MIME Types are valid for this input.

etag = None

Used to trigger updates. The only meaningful value is ${md5(file("path/to/file"))}. This attribute is not compatible with KMS encryption, kms_key_id or server_side_encryption = "aws:kms".

key = None

The name of the object once it is in the bucket.

kms_key_id = None

Specifies the AWS KMS Key ARN to use for object encryption. This value is a fully qualified ARN of the KMS Key. If using aws_kms_key, use the exported arn attribute: kms_key_id = "${aws_kms_key.foo.arn}"

server_side_encryption = None

Specifies server-side encryption of the object in S3. Valid values are “AES256” and “aws:kms”.

source = None

The path to a file that will be read and uploaded as raw bytes for the object content.

storage_class = None

Specifies the desired Storage Class for the object. Can be either “STANDARD”, “REDUCED_REDUNDANCY”, “ONEZONE_IA”, “INTELLIGENT_TIERING”, “GLACIER”, or “STANDARD_IA”. Defaults to “STANDARD”.

tags = None

A mapping of tags to assign to the object.

version_id = None

A unique version ID value for the object, if bucket versioning is enabled.

website_redirect = None

Specifies a target URL for website redirect.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.s3.BucketPolicy(resource_name, opts=None, bucket=None, policy=None, __name__=None, __opts__=None)

Attaches a policy to an S3 bucket resource.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • bucket (pulumi.Input[str]) – The name of the bucket to which to apply the policy.
  • policy (pulumi.Input[str]) –

    The text of the policy. For more information about building AWS IAM policy documents with Terraform, see the AWS IAM Policy Document Guide.

bucket = None

The name of the bucket to which to apply the policy.

policy = None

The text of the policy. For more information about building AWS IAM policy documents with Terraform, see the AWS IAM Policy Document Guide.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.s3.BucketPublicAccessBlock(resource_name, opts=None, block_public_acls=None, block_public_policy=None, bucket=None, ignore_public_acls=None, restrict_public_buckets=None, __name__=None, __opts__=None)

Manages S3 bucket-level Public Access Block configuration. For more information about these settings, see the AWS S3 Block Public Access documentation.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • block_public_acls (pulumi.Input[bool]) – Whether Amazon S3 should block public ACLs for this bucket. Defaults to false. Enabling this setting does not affect existing policies or ACLs. When set to true causes the following behavior:
Parameters:block_public_policy (pulumi.Input[bool]) – Whether Amazon S3 should block public bucket policies for this bucket. Defaults to false. Enabling this setting does not affect the existing bucket policy. When set to true causes Amazon S3 to:
Parameters:
  • bucket (pulumi.Input[str]) – S3 Bucket to which this Public Access Block configuration should be applied.
  • ignore_public_acls (pulumi.Input[bool]) – Whether Amazon S3 should ignore public ACLs for this bucket. Defaults to false. Enabling this setting does not affect the persistence of any existing ACLs and doesn’t prevent new public ACLs from being set. When set to true causes Amazon S3 to:
Parameters:restrict_public_buckets (pulumi.Input[bool]) – Whether Amazon S3 should restrict public bucket policies for this bucket. Defaults to false. Enabling this setting does not affect the previously stored bucket policy, except that public and cross-account access within the public bucket policy, including non-public delegation to specific accounts, is blocked. When set to true:
block_public_acls = None

Whether Amazon S3 should block public ACLs for this bucket. Defaults to false. Enabling this setting does not affect existing policies or ACLs. When set to true causes the following behavior:

  • PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public access.
  • PUT Object calls will fail if the request includes an object ACL.
block_public_policy = None

Whether Amazon S3 should block public bucket policies for this bucket. Defaults to false. Enabling this setting does not affect the existing bucket policy. When set to true causes Amazon S3 to:

  • Reject calls to PUT Bucket policy if the specified bucket policy allows public access.
bucket = None

S3 Bucket to which this Public Access Block configuration should be applied.

ignore_public_acls = None

Whether Amazon S3 should ignore public ACLs for this bucket. Defaults to false. Enabling this setting does not affect the persistence of any existing ACLs and doesn’t prevent new public ACLs from being set. When set to true causes Amazon S3 to:

  • Ignore all public ACLs on buckets in this account and any objects that they contain.
restrict_public_buckets = None

Whether Amazon S3 should restrict public bucket policies for this bucket. Defaults to false. Enabling this setting does not affect the previously stored bucket policy, except that public and cross-account access within the public bucket policy, including non-public delegation to specific accounts, is blocked. When set to true:

  • Only the bucket owner and AWS Services can access this buckets if it has a public policy.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.s3.GetBucketObjectResult(body=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_length=None, content_type=None, etag=None, expiration=None, expires=None, last_modified=None, metadata=None, server_side_encryption=None, sse_kms_key_id=None, storage_class=None, tags=None, version_id=None, website_redirect_location=None, id=None)

A collection of values returned by getBucketObject.

body = None

Object data (see limitations above to understand cases in which this field is actually available)

cache_control = None

Specifies caching behavior along the request/reply chain.

content_disposition = None

Specifies presentational information for the object.

content_encoding = None

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

content_language = None

The language the content is in.

content_length = None

Size of the body in bytes.

content_type = None

A standard MIME type describing the format of the object data.

etag = None

ETag generated for the object (an MD5 sum of the object content in case it’s not encrypted)

expiration = None

If the object expiration is configured (see object lifecycle management), the field includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded.

expires = None

The date and time at which the object is no longer cacheable.

last_modified = None

Last modified date of the object in RFC1123 format (e.g. Mon, 02 Jan 2006 15:04:05 MST)

metadata = None

A map of metadata stored with the object in S3

server_side_encryption = None

If the object is stored using server-side encryption (KMS or Amazon S3-managed encryption key), this field includes the chosen encryption and algorithm used.

sse_kms_key_id = None

If present, specifies the ID of the Key Management Service (KMS) master encryption key that was used for the object.

storage_class = None

Storage class information of the object. Available for all objects except for Standard storage class objects.

tags = None

A mapping of tags assigned to the object.

version_id = None

The latest version ID of the object returned.

website_redirect_location = None

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_aws.s3.GetBucketResult(arn=None, bucket_domain_name=None, hosted_zone_id=None, region=None, website_domain=None, website_endpoint=None, id=None)

A collection of values returned by getBucket.

arn = None

The ARN of the bucket. Will be of format arn:aws:s3:::bucketname.

bucket_domain_name = None

The bucket domain name. Will be of format bucketname.s3.amazonaws.com.

hosted_zone_id = None

The Route 53 Hosted Zone ID for this bucket’s region.

region = None

The AWS region this bucket resides in.

website_domain = None

The domain of the website endpoint, if the bucket is configured with a website. If not, this will be an empty string. This is used to create Route 53 alias records.

website_endpoint = None

The website endpoint, if the bucket is configured with a website. If not, this will be an empty string.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_aws.s3.Inventory(resource_name, opts=None, bucket=None, destination=None, enabled=None, filter=None, included_object_versions=None, name=None, optional_fields=None, schedule=None, __name__=None, __opts__=None)

Provides a S3 bucket inventory configuration resource.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • bucket (pulumi.Input[str]) – The S3 bucket configuration where inventory results are published (documented below).
  • destination (pulumi.Input[dict]) – Destination bucket where inventory list files are written (documented below).
  • enabled (pulumi.Input[bool]) – Specifies whether the inventory is enabled or disabled.
  • filter (pulumi.Input[dict]) – Object filtering that accepts a prefix (documented below).
  • included_object_versions (pulumi.Input[str]) – Object filtering that accepts a prefix (documented below). Can be All or Current.
  • name (pulumi.Input[str]) – Unique identifier of the inventory configuration for the bucket.
  • optional_fields (pulumi.Input[list]) – Contains the optional fields that are included in the inventory results.
  • schedule (pulumi.Input[dict]) – Contains the frequency for generating inventory results (documented below).
bucket = None

The S3 bucket configuration where inventory results are published (documented below).

destination = None

Destination bucket where inventory list files are written (documented below).

enabled = None

Specifies whether the inventory is enabled or disabled.

filter = None

Object filtering that accepts a prefix (documented below).

included_object_versions = None

Object filtering that accepts a prefix (documented below). Can be All or Current.

name = None

Unique identifier of the inventory configuration for the bucket.

optional_fields = None

Contains the optional fields that are included in the inventory results.

schedule = None

Contains the frequency for generating inventory results (documented below).

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
pulumi_aws.s3.get_bucket(bucket=None)

Provides details about a specific S3 bucket.

This resource may prove useful when setting up a Route53 record, or an origin for a CloudFront Distribution.

pulumi_aws.s3.get_bucket_object(bucket=None, key=None, range=None, tags=None, version_id=None)

The S3 object data source allows access to the metadata and optionally (see below) content of an object stored inside S3 bucket.

Note: The content of an object (body field) is available only for objects which have a human-readable Content-Type (text/* and application/json). This is to prevent printing unsafe characters and potentially downloading large amount of data which would be thrown away in favour of metadata.