Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Terraform module that creates an S3 bucket with an optional IAM user for external CI/CD systems

License

NotificationsYou must be signed in to change notification settings

cloudposse/terraform-aws-s3-bucket

Project Banner

GitHub Action TestsLatest ReleaseLast UpdatedSlack CommunityGet Support

This module creates an S3 bucket with support for versioning, lifecycles, object locks, replication, encryption, ACL,bucket object policies, and static website hosting.

For backward compatibility, it sets the S3 bucket ACL toprivate and thes3_object_ownershiptoObjectWriter. Moving forward, settings3_object_ownership toBucketOwnerEnforced is recommended,and doing so automatically disables the ACL.

This module blocks public access to the bucket by default. Seeblock_public_acls,block_public_policy,ignore_public_acls, andrestrict_public_buckets to change the settings. SeeAWS documentationfor more details.

This module can optionally create an IAM User with access to the S3 bucket. This is inherently insecure in thatto enable anyone to become the User, access keys must be generated, and anything generated by Terraform is storedunencrypted in the Terraform state. See theTerraform documentation for more details

The best way to grant access to the bucket is to grant one or more IAM Roles access to the bucket viaprivileged_principal_arns.This IAM Role can be assumed by EC2 instances via their Instance Profile, or Kubernetes (EKS) services usingIRSA.Entities outside of AWS can assume the Role viaOIDC.(Seethis example of connecting GitHubto enable GitHub actions to assume AWS IAM roles, or usethis Cloud Posse componentif you are already using the Cloud Posse reference architecture.)

If neither of those approaches work, then as a last resort you can setuser_enabled = true andthis module will provision a basic IAM user with permissions to access the bucket.We do not recommend creating IAM users this way for any other purpose.

If an IAM user is created, the IAM user name is constructed usingterraform-null-labeland some input is required. The simplest input isname. By default the name will be converted to lower caseand all non-alphanumeric characters except for hyphen will be removed. See the documentation forterraform-null-labelto learn how to override these defaults if desired.

If an AWS Access Key is created, it is stored either in SSM Parameter Store or is provided as a module output,but not both. Using SSM Parameter Store is recommended because that will keep the secret from being easily accessiblevia Terraform remote state lookup, but the key will still be stored unencrypted in the Terraform state in any case.

Tip

👽 Use Atmos with Terraform

Cloud Posse usesatmos to easily orchestrate multiple environments using Terraform.
Works withGithub Actions,Atlantis, orSpacelift.

Watch demo of using Atmos with Terraform
Example of runningatmos to manage infrastructure from ourQuick Start tutorial.

Usage

UsingBucketOwnerEnforced

module"s3_bucket" {source="cloudposse/s3-bucket/aws"# Cloud Posse recommends pinning every module to a specific version# version = "x.x.x"name="app"stage="test"namespace="eg"s3_object_ownership="BucketOwnerEnforced"enabled=trueuser_enabled=falseversioning_enabled=falseprivileged_principal_actions=["s3:GetObject","s3:ListBucket","s3:GetBucketLocation"]privileged_principal_arns=[    {      (local.deployment_iam_role_arn)= [""]    },    {      (local.additional_deployment_iam_role_arn)= ["prefix1/","prefix2/"]    }  ]}

Configuring S3storage lifecycle:

locals {lifecycle_configuration_rules=[{    enabled=true# bool    id="v2rule"    abort_incomplete_multipart_upload_days=1# number    filter_and=null    expiration= {      days=120# integer > 0    }    noncurrent_version_expiration= {      newer_noncurrent_versions=3# integer > 0      noncurrent_days=60# integer >= 0    }    transition= [{      days=30# integer >= 0      storage_class="STANDARD_IA"# string/enum, one of GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE, GLACIER_IR.      },      {        days=60# integer >= 0        storage_class="ONEZONE_IA"# string/enum, one of GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE, GLACIER_IR.    }]    noncurrent_version_transition= [{      newer_noncurrent_versions=3# integer >= 0      noncurrent_days=30# integer >= 0      storage_class="ONEZONE_IA"# string/enum, one of GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE, GLACIER_IR.    }]  }]}

Allowing specific principal ARNs to perform actions on the bucket:

module"s3_bucket" {source="cloudposse/s3-bucket/aws"# Cloud Posse recommends pinning every module to a specific version# version = "x.x.x"s3_object_ownership="BucketOwnerEnforced"enabled=trueuser_enabled=trueversioning_enabled=falseallowed_bucket_actions=["s3:GetObject","s3:ListBucket","s3:GetBucketLocation"]name="app"stage="test"namespace="eg"privileged_principal_arns=[  {"arn:aws:iam::123456789012:role/principal1"= ["prefix1/","prefix2/"]  }, {"arn:aws:iam::123456789012:role/principal2"= [""]  }]privileged_principal_actions=["s3:PutObject","s3:PutObjectAcl","s3:GetObject","s3:DeleteObject","s3:ListBucket","s3:ListBucketMultipartUploads","s3:GetBucketLocation","s3:AbortMultipartUpload"  ]}

Important

In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentationand the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact versionyou're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematicapproach for updating versions to avoid unexpected changes.

Requirements

NameVersion
terraform>= 1.3.0
aws>= 4.9.0
time>= 0.7

Providers

NameVersion
aws>= 4.9.0
time>= 0.7

Modules

NameSourceVersion
s3_usercloudposse/iam-s3-user/aws1.2.0
thiscloudposse/label/null0.25.0

Resources

NameType
aws_iam_policy.replicationresource
aws_iam_role.replicationresource
aws_iam_role_policy_attachment.replicationresource
aws_s3_bucket.defaultresource
aws_s3_bucket_accelerate_configuration.defaultresource
aws_s3_bucket_acl.defaultresource
aws_s3_bucket_cors_configuration.defaultresource
aws_s3_bucket_lifecycle_configuration.defaultresource
aws_s3_bucket_logging.defaultresource
aws_s3_bucket_notification.bucket_notificationresource
aws_s3_bucket_object_lock_configuration.defaultresource
aws_s3_bucket_ownership_controls.defaultresource
aws_s3_bucket_policy.defaultresource
aws_s3_bucket_public_access_block.defaultresource
aws_s3_bucket_replication_configuration.defaultresource
aws_s3_bucket_request_payment_configuration.defaultresource
aws_s3_bucket_server_side_encryption_configuration.defaultresource
aws_s3_bucket_versioning.defaultresource
aws_s3_bucket_website_configuration.defaultresource
aws_s3_bucket_website_configuration.redirectresource
aws_s3_directory_bucket.defaultresource
time_sleep.wait_for_aws_s3_bucket_settingsresource
aws_canonical_user_id.defaultdata source
aws_iam_policy_document.aggregated_policydata source
aws_iam_policy_document.bucket_policydata source
aws_iam_policy_document.replicationdata source
aws_iam_policy_document.replication_stsdata source
aws_partition.currentdata source

Inputs

NameDescriptionTypeDefaultRequired
access_key_enabledSet totrue to create an IAM Access Key for the created IAM userbooltrueno
aclThecanned ACL to apply.
Deprecated by AWS in favor of bucket policies.
Automatically disabled ifs3_object_ownership is set to "BucketOwnerEnforced".
Defaults to "private" for backwards compatibility, but we recommend settings3_object_ownership to "BucketOwnerEnforced" instead.
string"private"no
additional_tag_mapAdditional key-value pairs to add to each map intags_as_list_of_maps. Not added totags orid.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.
map(string){}no
allow_encrypted_uploads_onlySet totrue to prevent uploads of unencrypted objects to S3 bucketboolfalseno
allow_ssl_requests_onlySet totrue to require requests to use Secure Socket Layer (HTTPS/SSL). This will explicitly deny access to HTTP requestsboolfalseno
allowed_bucket_actionsList of actions the user is permitted to perform on the S3 bucketlist(string)
[
"s3:PutObject",
"s3:PutObjectAcl",
"s3:GetObject",
"s3:DeleteObject",
"s3:ListBucket",
"s3:ListBucketMultipartUploads",
"s3:GetBucketLocation",
"s3:AbortMultipartUpload"
]
no
attributesID element. Additional attributes (e.g.workers orcluster) to add toid,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by thedelimiter
and treated as a single ID element.
list(string)[]no
availability_zone_idThe ID of the availability zone.string""no
block_public_aclsSet tofalse to disable the blocking of new public access lists on the bucketbooltrueno
block_public_policySet tofalse to disable the blocking of new public policies on the bucketbooltrueno
bucket_key_enabledSet this to true to use Amazon S3 Bucket Keys for SSE-KMS, which may or may not reduce the number of AWS KMS requests.
For more information, see:https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html
boolfalseno
bucket_nameBucket name. If provided, the bucket will be created with this name instead of generating the name from the contextstringnullno
contextSingle object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables asnull to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.
any
{
"additional_tag_map": {},
"attributes": [],
"delimiter": null,
"descriptor_formats": {},
"enabled": true,
"environment": null,
"id_length_limit": null,
"label_key_case": null,
"label_order": [],
"label_value_case": null,
"labels_as_tags": [
"unset"
],
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
}
no
cors_configurationSpecifies the allowed headers, methods, origins and exposed headers when using CORS on this bucket
list(object({
id = optional(string)
allowed_headers = optional(list(string))
allowed_methods = optional(list(string))
allowed_origins = optional(list(string))
expose_headers = optional(list(string))
max_age_seconds = optional(number)
}))
[]no
create_s3_directory_bucketControl the creation of the S3 directory bucket. Set to true to create the bucket, false to skip.boolfalseno
delimiterDelimiter to be used between ID elements.
Defaults to- (hyphen). Set to"" to use no delimiter at all.
stringnullno
descriptor_formatsDescribe additional descriptors to be output in thedescriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
{<br/> format = string<br/> labels = list(string)<br/>}
(Type isany so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to theformat() function.
labels is a list of labels, in order, to pass toformat() function.
Label values will be normalized before being passed toformat() so they will be
identical to how they appear inid.
Default is{} (descriptors output will be empty).
any{}no
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
event_notification_detailsS3 event notification details
object({
enabled = bool
eventbridge = optional(bool, false)
lambda_list = optional(list(object({
lambda_function_arn = string
events = optional(list(string), ["s3:ObjectCreated:"])
filter_prefix = optional(string)
filter_suffix = optional(string)
})), [])

queue_list = optional(list(object({
queue_arn = string
events = optional(list(string), ["s3:ObjectCreated:
"])
filter_prefix = optional(string)
filter_suffix = optional(string)
})), [])

topic_list = optional(list(object({
topic_arn = string
events = optional(list(string), ["s3:ObjectCreated:*"])
filter_prefix = optional(string)
filter_suffix = optional(string)
})), [])
})
{
"enabled": false
}
no
expected_bucket_ownerAccount ID of the expected bucket owner.
More information:https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-owner-condition.html
stringnullno
force_destroyWhentrue, permits a non-empty S3 bucket to be deleted by first deleting all objects in the bucket.
THESE OBJECTS ARE NOT RECOVERABLE even if they were versioned and stored in Glacier.
boolfalseno
grantsA list of policy grants for the bucket, taking a list of permissions.
Conflicts withacl. Setacl tonull to use this.
Deprecated by AWS in favor of bucket policies.
Automatically disabled ifs3_object_ownership is set to "BucketOwnerEnforced".
list(object({
id = string
type = string
permissions = list(string)
uri = string
}))
[]no
id_length_limitLimitid to this many characters (minimum 6).
Set to0 for unlimited length.
Set tonull for keep the existing setting, which defaults to0.
Does not affectid_full.
numbernullno
ignore_public_aclsSet tofalse to disable the ignoring of public access lists on the bucketbooltrueno
kms_master_key_arnThe AWS KMS master key ARN used for theSSE-KMS encryption. This can only be used when you set the value ofsse_algorithm asaws:kms. The default aws/s3 AWS KMS master key is used if this element is absent while thesse_algorithm isaws:kmsstring""no
label_key_caseControls the letter case of thetags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via thetags input.
Possible values:lower,title,upper.
Default value:title.
stringnullno
label_orderThe order in which the labels (ID elements) appear in theid.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.
list(string)nullno
label_value_caseControls the letter case of ID elements (labels) as included inid,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via thetags input.
Possible values:lower,title,upper andnone (no transformation).
Set this totitle and setdelimiter to"" to yield Pascal Case IDs.
Default value:lower.
stringnullno
labels_as_tagsSet of labels (ID elements) to include as tags in thetags output.
Default is to include all labels.
Tags with empty values will not be included in thetags output.
Set to[] to suppress all generated tags.
Notes:
The value of thename tag, if included, will be theid, not thename.
Unlike othernull-label inputs, the initial setting oflabels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.
set(string)
[
"default"
]
no
lifecycle_configuration_rulesA list of lifecycle V2 rules
list(object({
enabled = optional(bool, true)
id = string

abort_incomplete_multipart_upload_days = optional(number)

#filter_and is theand configuration block inside thefilter configuration.
# This is the only place you should specify a prefix.
filter_and = optional(object({
object_size_greater_than = optional(number) # integer >= 0
object_size_less_than = optional(number) # integer >= 1
prefix = optional(string)
tags = optional(map(string), {})
}))
expiration = optional(object({
date = optional(string) # string, RFC3339 time format, GMT
days = optional(number) # integer > 0
expired_object_delete_marker = optional(bool)
}))
noncurrent_version_expiration = optional(object({
newer_noncurrent_versions = optional(number) # integer > 0
noncurrent_days = optional(number) # integer >= 0
}))
transition = optional(list(object({
date = optional(string) # string, RFC3339 time format, GMT
days = optional(number) # integer > 0
storage_class = optional(string)
# string/enum, one of GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE, GLACIER_IR.
})), [])

noncurrent_version_transition = optional(list(object({
newer_noncurrent_versions = optional(number) # integer >= 0
noncurrent_days = optional(number) # integer >= 0
storage_class = optional(string)
# string/enum, one of GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE, GLACIER_IR.
})), [])
}))
[]no
lifecycle_rule_idsDEPRECATED (uselifecycle_configuration_rules): A list of IDs to assign to correspondinglifecycle_ruleslist(string)[]no
lifecycle_rulesDEPRECATED (use lifecycle_configuration_rules): A list of lifecycle rules
list(object({
prefix = string
enabled = bool
tags = map(string)

enable_glacier_transition = bool
enable_deeparchive_transition = bool
enable_standard_ia_transition = bool
enable_current_object_expiration = bool
enable_noncurrent_version_expiration = bool

abort_incomplete_multipart_upload_days = number
noncurrent_version_glacier_transition_days = number
noncurrent_version_deeparchive_transition_days = number
noncurrent_version_expiration_days = number

standard_transition_days = number
glacier_transition_days = number
deeparchive_transition_days = number
expiration_days = number
}))
nullno
loggingBucket access logging configuration. Empty list for no logging, list of 1 to enable logging.
list(object({
bucket_name = string
prefix = string
}))
[]no
minimum_tls_versionSet the minimum TLS version for in-transit trafficstringnullno
nameID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as atag.
The "name" tag is set to the fullid string. There is no tag with the value of thename input.
stringnullno
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
object_lock_configurationA configuration for S3 object locking. With S3 Object Lock, you can store objects using awrite once, read many (WORM) model. Object Lock can help prevent objects from being deleted or overwritten for a fixed amount of time or indefinitely.
object({
mode = string # Valid values are GOVERNANCE and COMPLIANCE.
days = number
years = number
})
nullno
privileged_principal_actionsList of actions to permitprivileged_principal_arns to perform on bucket and bucket prefixes (seeprivileged_principal_arns)list(string)[]no
privileged_principal_arnsList of maps. Each map has a key, an IAM Principal ARN, whose associated value is
a list of S3 path prefixes to grantprivileged_principal_actions permissions for that principal,
in addition to the bucket itself, which is automatically included. Prefixes should not begin with '/'.
list(map(list(string)))[]no
regex_replace_charsTerraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set,"/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.
stringnullno
replication_rulesDEPRECATED (uses3_replication_rules): Specifies the replication rules for S3 bucket replication if enabled. You must also set s3_replication_enabled to true.list(any)nullno
restrict_public_bucketsSet tofalse to disable the restricting of making the bucket publicbooltrueno
s3_object_ownershipSpecifies the S3 object ownership control.
Valid values areObjectWriter,BucketOwnerPreferred, and 'BucketOwnerEnforced'.
Defaults to "ObjectWriter" for backwards compatibility, but we recommend setting "BucketOwnerEnforced" instead.
string"ObjectWriter"no
s3_replica_bucket_arnA single S3 bucket ARN to use for all replication rules.
Note: The destination bucket can be specified in the replication rule itself
(which allows for multiple destinations), in which case it will take precedence over this variable.
string""no
s3_replication_enabledSet this to true and specifys3_replication_rules to enable replication.versioning_enabled must also betrue.boolfalseno
s3_replication_permissions_boundary_arnPermissions boundary ARN for the created IAM replication role.stringnullno
s3_replication_rulesSpecifies the replication rules for S3 bucket replication if enabled. You must also set s3_replication_enabled to true.
list(object({
id = optional(string)
priority = optional(number)
prefix = optional(string)
status = optional(string, "Enabled")
# delete_marker_replication { status } had been flattened for convenience
delete_marker_replication_status = optional(string, "Disabled")
# Add the configuration as it appears in the resource, for consistency
# this nested version takes precedence if both are provided.
delete_marker_replication = optional(object({
status = string
}))

# destination_bucket is specified here rather than inside the destination object because before optional
# attributes, it made it easier to work with the Terraform type system and create a list of consistent type.
# It is preserved for backward compatibility, but the nested version takes priority if both are provided.
destination_bucket = optional(string) # destination bucket ARN, overrides s3_replica_bucket_arn

destination = object({
bucket = optional(string) # destination bucket ARN, overrides s3_replica_bucket_arn
storage_class = optional(string, "STANDARD")
# replica_kms_key_id at this level is for backward compatibility, and is overridden by the one inencryption_configuration
replica_kms_key_id = optional(string, "")
encryption_configuration = optional(object({
replica_kms_key_id = string
}))
access_control_translation = optional(object({
owner = string
}))
# account_id is for backward compatibility, overridden by account
account_id = optional(string)
account = optional(string)
# For convenience, specifying either metrics or replication_time enables both
metrics = optional(object({
event_threshold = optional(object({
minutes = optional(number, 15) # Currently 15 is the only valid number
}), { minutes = 15 })
status = optional(string, "Enabled")
}), { status = "Disabled" })
# To preserve backward compatibility, Replication Time Control (RTC) is automatically enabled
# when metrics are enabled. To enable metrics without RTC, you must explicitly configure
# replication_time.status = "Disabled".
replication_time = optional(object({
time = optional(object({
minutes = optional(number, 15) # Currently 15 is the only valid number
}), { minutes = 15 })
status = optional(string)
}))
})

source_selection_criteria = optional(object({
replica_modifications = optional(object({
status = string # Either Enabled or Disabled
}))
sse_kms_encrypted_objects = optional(object({
status = optional(string)
}))
}))
# filter.prefix overrides top level prefix
filter = optional(object({
prefix = optional(string)
tags = optional(map(string), {})
}))
}))
nullno
s3_replication_source_rolesCross-account IAM Role ARNs that will be allowed to perform S3 replication to this bucket (for replication within the same AWS account, it's not necessary to adjust the bucket policy).list(string)[]no
s3_request_payment_configurationS3 request payment configuration
object({
enabled = bool
expected_bucket_owner = optional(string)
payer = string
})
{
"enabled": false,
"payer": "BucketOwner"
}
no
source_ip_allow_listList of IP addresses to allow to perform all actions to the bucketlist(string)[]no
source_policy_documentsList of IAM policy documents (in JSON) that are merged together into the exported document.
Statements defined in source_policy_documents must have unique SIDs.
Statement having SIDs that match policy SIDs generated by this module will override them.
list(string)[]no
sse_algorithmThe server-side encryption algorithm to use. Valid values areAES256 andaws:kmsstring"AES256"no
ssm_base_pathThe base path for SSM parameters where created IAM user's access key is storedstring"/s3_user/"no
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
store_access_key_in_ssmSet totrue to store the created IAM user's access key in SSM Parameter Store,
false to store them in Terraform state as outputs.
Since Terraform state would contain the secrets in plaintext,
use of SSM Parameter Store is recommended.
boolfalseno
tagsAdditional tags (e.g.{'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
map(string){}no
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
transfer_acceleration_enabledSet this totrue to enable S3 Transfer Acceleration for the bucket.
Note: When this is set tofalse Terraform does not perform drift detection
and will not disable Transfer Acceleration if it was enabled outside of Terraform.
To disable it via Terraform, you must set this totrue and then tofalse.
Note: not all regions support Transfer Acceleration.
boolfalseno
user_enabledSet totrue to create an IAM user with permission to access the bucketboolfalseno
user_permissions_boundary_arnPermission boundary ARN for the IAM user created to access the bucket.stringnullno
versioning_enabledA state of versioning. Versioning is a means of keeping multiple variants of an object in the same bucketbooltrueno
website_configurationSpecifies the static website hosting configuration object
list(object({
index_document = string
error_document = string
routing_rules = list(object({
condition = object({
http_error_code_returned_equals = string
key_prefix_equals = string
})
redirect = object({
host_name = string
http_redirect_code = string
protocol = string
replace_key_prefix_with = string
replace_key_with = string
})
}))
}))
[]no
website_redirect_all_requests_toIf provided, all website requests will be redirected to the specified host name and protocol
list(object({
host_name = string
protocol = string
}))
[]no

Outputs

NameDescription
access_key_idThe access key ID, ifvar.user_enabled && var.access_key_enabled.
While sensitive, it does not need to be kept secret, so this is output regardless ofvar.store_access_key_in_ssm.
access_key_id_ssm_pathThe SSM Path under which the S3 User's access key ID is stored
bucket_arnBucket ARN
bucket_domain_nameFQDN of bucket
bucket_idBucket Name (aka ID)
bucket_regionBucket region
bucket_regional_domain_nameThe bucket region-specific domain name
bucket_website_domainThe bucket website domain, if website is enabled
bucket_website_endpointThe bucket website endpoint, if website is enabled
enabledIs module enabled
replication_role_arnThe ARN of the replication IAM Role
secret_access_keyThe secret access key will be output if created and not stored in SSM. However, the secret access key, if created,
will be written to the Terraform state file unencrypted, regardless of any other settings.
See theTerraform documentation for more details.
secret_access_key_ssm_pathThe SSM Path under which the S3 User's secret access key is stored
user_arnThe ARN assigned by AWS for the user
user_enabledIs user creation enabled
user_nameNormalized IAM user name
user_unique_idThe user unique ID assigned by AWS

Related Projects

Check out these related projects.

Tip

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-goterraform architecture blueprints for AWS to get up and running quickly.

✅ We build it together with your team.
✅ Your team owns everything.
✅ 100% Open Source and backed by fanatical support.

Request Quote

📚Learn More

Cloud Posse is the leadingDevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

  • Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
  • Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
  • Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
  • Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
  • GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

Request Quote

Day-2: Your Operational Mastery

  • Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
  • Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
  • Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
  • Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
  • Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
  • Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
  • Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

Request Quote

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use theissue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Review ourCode of Conduct andContributor Guidelines.
  2. Fork the repo on GitHub
  3. Clone the project to your own machine
  4. Commit changes to your own branch
  5. Push your work back up to your fork
  6. Submit aPull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Running Terraform Tests

We useAtmos to streamline how Terraform tests are run. It centralizes configuration and wraps common test workflows with easy-to-use commands.

All tests are located in thetest/ folder.

Under the hood, tests are powered by Terratest together with our internalTest Helpers library, providing robust infrastructure validation.

Setup dependencies:

To run tests:

  • Run all tests:
    atmostest run
  • Clean up test artifacts:
    atmostest clean
  • Explore additional test options:
    atmostest --help

The configuration for test commands is centrally managed. To review what's being imported, see theatmos.yaml file.

Learn more about ourautomated testing in our documentation or implementingcustom commands with atmos.

🌎 Slack Community

Join ourOpen Source Community on Slack. It'sFREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totallysweet infrastructure.

📰 Newsletter

Sign up forour newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know.Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus alive Q&A that you can’t find anywhere else.It'sFREE for everyone!

License

License

Preamble to the Apache License, Version 2.0

Complete license is available in theLICENSE file.

Licensed to the Apache Software Foundation (ASF) under oneor more contributor license agreements.  See the NOTICE filedistributed with this work for additional informationregarding copyright ownership.  The ASF licenses this fileto you under the Apache License, Version 2.0 (the"License"); you may not use this file except in compliancewith the License.  You may obtain a copy of the License at  https://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing,software distributed under the License is distributed on an"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANYKIND, either express or implied.  See the License for thespecific language governing permissions and limitationsunder the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.


Copyright © 2017-2025Cloud Posse, LLC

README footer

Beacon

About

Terraform module that creates an S3 bucket with an optional IAM user for external CI/CD systems

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published

[8]ページ先頭

©2009-2025 Movatter.jp