s3

package
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 8, 2022 License: MPL-2.0 Imports: 41 Imported by: 0

README

Terraform AWS Provider S3 Package

This area is primarily for AWS provider contributors and maintainers. For information on using Terraform and the AWS provider, see the links below.

Documentation

Overview

Code generated by internal/generate/tags/main.go; DO NOT EDIT.

Index

Constants

View Source 
const (
	BucketCannedACLExecRead         = "aws-exec-read"
	BucketCannedACLLogDeliveryWrite = "log-delivery-write"

	BucketVersioningStatusDisabled = "Disabled"

	LifecycleRuleStatusEnabled  = "Enabled"
	LifecycleRuleStatusDisabled = "Disabled"
)

These should be defined in the AWS SDK for Go. There is an open issue https://github.com/aws/aws-sdk-go/issues/2683

View Source 
const (
	ErrCodeAccessDenied                              = "AccessDenied"
	ErrCodeBucketNotEmpty                            = "BucketNotEmpty"
	ErrCodeInvalidBucketState                        = "InvalidBucketState"
	ErrCodeInvalidRequest                            = "InvalidRequest"
	ErrCodeMalformedPolicy                           = "MalformedPolicy"
	ErrCodeMethodNotAllowed                          = "MethodNotAllowed"
	ErrCodeNoSuchBucketPolicy                        = "NoSuchBucketPolicy"
	ErrCodeNoSuchConfiguration                       = "NoSuchConfiguration"
	ErrCodeNoSuchCORSConfiguration                   = "NoSuchCORSConfiguration"
	ErrCodeNoSuchLifecycleConfiguration              = "NoSuchLifecycleConfiguration"
	ErrCodeNoSuchPublicAccessBlockConfiguration      = "NoSuchPublicAccessBlockConfiguration"
	ErrCodeNoSuchWebsiteConfiguration                = "NoSuchWebsiteConfiguration"
	ErrCodeNotImplemented                            = "NotImplemented"
	ErrCodeObjectLockConfigurationNotFound           = "ObjectLockConfigurationNotFoundError"
	ErrCodeOperationAborted                          = "OperationAborted"
	ErrCodeReplicationConfigurationNotFound          = "ReplicationConfigurationNotFoundError"
	ErrCodeServerSideEncryptionConfigurationNotFound = "ServerSideEncryptionConfigurationNotFoundError"
	ErrCodeUnsupportedArgument                       = "UnsupportedArgument"

	// ErrCodeXNotImplemented is returned from Third Party S3 implementations
	// and so far has been noticed with calls to GetBucketWebsite.
	// Reference: https://github.com/ATenderholt/rainbow-test/issues/14645
	ErrCodeXNotImplemented = "XNotImplemented"
)
View Source 
const (

	// LifecycleConfigurationRulesStatusReady occurs when all configured rules reach their desired state (Enabled or Disabled)
	LifecycleConfigurationRulesStatusReady = "READY"
	// LifecycleConfigurationRulesStatusNotReady occurs when all configured rules have not reached their desired state (Enabled or Disabled)
	LifecycleConfigurationRulesStatusNotReady = "NOT_READY"
)
View Source 
const BucketACLSeparator = ","
View Source 
const DefaultKMSKeyAlias = "alias/aws/s3"
View Source 
const (
	ErrCodeNoSuchTagSet = "NoSuchTagSet"
)
View Source 
const (
	ErrMessageBucketAlreadyExists = "bucket already exists"
)

Variables

This section is empty.

Functions

func BucketACLCreateResourceID 

func BucketACLCreateResourceID(bucket, expectedBucketOwner, acl string) string

BucketACLCreateResourceID is a method for creating an ID string with the bucket name and optional accountID and/or ACL.

func BucketACLParseResourceID 

func BucketACLParseResourceID(id string) (string, string, string, error)

BucketACLParseResourceID is a method for parsing the ID string for the bucket name, accountID, and ACL if provided.

func BucketAnalyticsConfigurationParseID 

func BucketAnalyticsConfigurationParseID(id string) (string, string, error)

func BucketCannedACL_Values 

func BucketCannedACL_Values() []string

func BucketIntelligentTieringConfigurationCreateResourceID 

func BucketIntelligentTieringConfigurationCreateResourceID(bucketName, configurationName string) string

func BucketIntelligentTieringConfigurationParseResourceID 

func BucketIntelligentTieringConfigurationParseResourceID(id string) (string, string, error)

func BucketInventoryParseID 

func BucketInventoryParseID(id string) (string, string, error)

func BucketListTags 

func BucketListTags(conn *s3.S3, identifier string) (tftags.KeyValueTags, error)

BucketListTags lists S3 bucket tags. The identifier is the bucket name.

func BucketMetricParseID 

func BucketMetricParseID(id string) (string, string, error)

func BucketRegionalDomainName 

func BucketRegionalDomainName(bucket string, region string) (string, error)

https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region

func BucketUpdateTags 

func BucketUpdateTags(conn *s3.S3, identifier string, oldTagsMap interface{}, newTagsMap interface{}) error

BucketUpdateTags updates S3 bucket tags. The identifier is the bucket name.

func BucketVersioningStatus_Values 

func BucketVersioningStatus_Values() []string

func CreateResourceID 

func CreateResourceID(bucket, expectedBucketOwner string) string

CreateResourceID is a generic method for creating an ID string for a bucket-related resource e.g. aws_s3_bucket_versioning. The method expects a bucket name and an optional accountID.

func DataSourceBucket 

func DataSourceBucket() *schema.Resource

func DataSourceBucketObject 

func DataSourceBucketObject() *schema.Resource

func DataSourceBucketObjects 

func DataSourceBucketObjects() *schema.Resource

func DataSourceBucketPolicy 

func DataSourceBucketPolicy() *schema.Resource

func DataSourceCanonicalUserID 

func DataSourceCanonicalUserID() *schema.Resource

func DataSourceObject 

func DataSourceObject() *schema.Resource

func DataSourceObjects 

func DataSourceObjects() *schema.Resource

func DeleteAllObjectVersions 

func DeleteAllObjectVersions(conn *s3.S3, bucketName, key string, force, ignoreObjectErrors bool) (int64, error)

DeleteAllObjectVersions deletes all versions of a specified key from an S3 bucket. If key is empty then all versions of all objects are deleted. Set force to true to override any S3 object lock protections on object lock enabled buckets. Returns the number of objects deleted.

func EmptyBucket 

func EmptyBucket(ctx context.Context, conn *s3.S3, bucket string, force bool) (int64, error)

EmptyBucket empties the specified S3 bucket by deleting all object versions and delete markers. If `force` is `true` then S3 Object Lock governance mode restrictions are bypassed and an attempt is made to remove any S3 Object Lock legal holds. Returns the number of objects deleted.

func ExpandAnalyticsFilter 

func ExpandAnalyticsFilter(l []interface{}) *s3.AnalyticsFilter

func ExpandLifecycleRuleAbortIncompleteMultipartUpload 

func ExpandLifecycleRuleAbortIncompleteMultipartUpload(m map[string]interface{}) *s3.AbortIncompleteMultipartUpload

func ExpandLifecycleRuleExpiration 

func ExpandLifecycleRuleExpiration(l []interface{}) (*s3.LifecycleExpiration, error)

func ExpandLifecycleRuleFilter 

func ExpandLifecycleRuleFilter(l []interface{}) *s3.LifecycleRuleFilter

ExpandLifecycleRuleFilter ensures a Filter can have only 1 of prefix, tag, or and

func ExpandLifecycleRuleFilterAndOperator 

func ExpandLifecycleRuleFilterAndOperator(m map[string]interface{}) *s3.LifecycleRuleAndOperator

func ExpandLifecycleRuleFilterTag 

func ExpandLifecycleRuleFilterTag(m map[string]interface{}) *s3.Tag

func ExpandLifecycleRuleNoncurrentVersionExpiration 

func ExpandLifecycleRuleNoncurrentVersionExpiration(m map[string]interface{}) *s3.NoncurrentVersionExpiration

func ExpandLifecycleRuleNoncurrentVersionTransitions 

func ExpandLifecycleRuleNoncurrentVersionTransitions(l []interface{}) []*s3.NoncurrentVersionTransition

func ExpandLifecycleRuleTransitions 

func ExpandLifecycleRuleTransitions(l []interface{}) ([]*s3.Transition, error)

func ExpandLifecycleRules 

func ExpandLifecycleRules(l []interface{}) ([]*s3.LifecycleRule, error)

func ExpandMetricsFilter 

func ExpandMetricsFilter(m map[string]interface{}) *s3.MetricsFilter

func ExpandReplicationRuleDeleteMarkerReplication 

func ExpandReplicationRuleDeleteMarkerReplication(l []interface{}) *s3.DeleteMarkerReplication

func ExpandReplicationRuleDestination 

func ExpandReplicationRuleDestination(l []interface{}) *s3.Destination

func ExpandReplicationRuleDestinationAccessControlTranslation 

func ExpandReplicationRuleDestinationAccessControlTranslation(l []interface{}) *s3.AccessControlTranslation

func ExpandReplicationRuleDestinationEncryptionConfiguration 

func ExpandReplicationRuleDestinationEncryptionConfiguration(l []interface{}) *s3.EncryptionConfiguration

func ExpandReplicationRuleDestinationMetrics 

func ExpandReplicationRuleDestinationMetrics(l []interface{}) *s3.Metrics

func ExpandReplicationRuleDestinationReplicationTime 

func ExpandReplicationRuleDestinationReplicationTime(l []interface{}) *s3.ReplicationTime

func ExpandReplicationRuleDestinationReplicationTimeValue 

func ExpandReplicationRuleDestinationReplicationTimeValue(l []interface{}) *s3.ReplicationTimeValue

func ExpandReplicationRuleExistingObjectReplication 

func ExpandReplicationRuleExistingObjectReplication(l []interface{}) *s3.ExistingObjectReplication

func ExpandReplicationRuleFilter 

func ExpandReplicationRuleFilter(l []interface{}) *s3.ReplicationRuleFilter

func ExpandReplicationRuleFilterAndOperator 

func ExpandReplicationRuleFilterAndOperator(l []interface{}) *s3.ReplicationRuleAndOperator

func ExpandReplicationRuleFilterTag 

func ExpandReplicationRuleFilterTag(l []interface{}) *s3.Tag

func ExpandReplicationRuleSourceSelectionCriteria 

func ExpandReplicationRuleSourceSelectionCriteria(l []interface{}) *s3.SourceSelectionCriteria

func ExpandReplicationRules 

func ExpandReplicationRules(l []interface{}) []*s3.ReplicationRule

func ExpandSourceSelectionCriteriaReplicaModifications 

func ExpandSourceSelectionCriteriaReplicaModifications(l []interface{}) *s3.ReplicaModifications

func ExpandSourceSelectionCriteriaSSEKMSEncryptedObjects 

func ExpandSourceSelectionCriteriaSSEKMSEncryptedObjects(l []interface{}) *s3.SseKmsEncryptedObjects

func ExpandStorageClassAnalysis 

func ExpandStorageClassAnalysis(l []interface{}) *s3.StorageClassAnalysis

func FindBucketIntelligentTieringConfiguration 

func FindBucketIntelligentTieringConfiguration(conn *s3.S3, bucketName, configurationName string) (*s3.IntelligentTieringConfiguration, error)

func FindBucketPolicy 

func FindBucketPolicy(ctx context.Context, conn *s3.S3, name string) (*s3.GetBucketPolicyOutput, error)

func FlattenAnalyticsFilter 

func FlattenAnalyticsFilter(analyticsFilter *s3.AnalyticsFilter) []map[string]interface{}

func FlattenLifecycleRuleAbortIncompleteMultipartUpload 

func FlattenLifecycleRuleAbortIncompleteMultipartUpload(u *s3.AbortIncompleteMultipartUpload) []interface{}

func FlattenLifecycleRuleExpiration 

func FlattenLifecycleRuleExpiration(expiration *s3.LifecycleExpiration) []interface{}

func FlattenLifecycleRuleFilter 

func FlattenLifecycleRuleFilter(filter *s3.LifecycleRuleFilter) []interface{}

func FlattenLifecycleRuleFilterAndOperator 

func FlattenLifecycleRuleFilterAndOperator(andOp *s3.LifecycleRuleAndOperator) []interface{}

func FlattenLifecycleRuleFilterTag 

func FlattenLifecycleRuleFilterTag(tag *s3.Tag) []interface{}

func FlattenLifecycleRuleNoncurrentVersionExpiration 

func FlattenLifecycleRuleNoncurrentVersionExpiration(expiration *s3.NoncurrentVersionExpiration) []interface{}

func FlattenLifecycleRuleNoncurrentVersionTransitions 

func FlattenLifecycleRuleNoncurrentVersionTransitions(transitions []*s3.NoncurrentVersionTransition) []interface{}

func FlattenLifecycleRuleTransitions 

func FlattenLifecycleRuleTransitions(transitions []*s3.Transition) []interface{}

func FlattenLifecycleRules 

func FlattenLifecycleRules(rules []*s3.LifecycleRule) []interface{}

func FlattenMetricsFilter 

func FlattenMetricsFilter(metricsFilter *s3.MetricsFilter) map[string]interface{}

func FlattenReplicationRuleDeleteMarkerReplication 

func FlattenReplicationRuleDeleteMarkerReplication(dmr *s3.DeleteMarkerReplication) []interface{}

func FlattenReplicationRuleDestination 

func FlattenReplicationRuleDestination(dest *s3.Destination) []interface{}

func FlattenReplicationRuleDestinationAccessControlTranslation 

func FlattenReplicationRuleDestinationAccessControlTranslation(act *s3.AccessControlTranslation) []interface{}

func FlattenReplicationRuleDestinationEncryptionConfiguration 

func FlattenReplicationRuleDestinationEncryptionConfiguration(ec *s3.EncryptionConfiguration) []interface{}

func FlattenReplicationRuleDestinationMetrics 

func FlattenReplicationRuleDestinationMetrics(metrics *s3.Metrics) []interface{}

func FlattenReplicationRuleDestinationReplicationTime 

func FlattenReplicationRuleDestinationReplicationTime(rt *s3.ReplicationTime) []interface{}

func FlattenReplicationRuleDestinationReplicationTimeValue 

func FlattenReplicationRuleDestinationReplicationTimeValue(rtv *s3.ReplicationTimeValue) []interface{}

func FlattenReplicationRuleExistingObjectReplication 

func FlattenReplicationRuleExistingObjectReplication(eor *s3.ExistingObjectReplication) []interface{}

func FlattenReplicationRuleFilter 

func FlattenReplicationRuleFilter(filter *s3.ReplicationRuleFilter) []interface{}

func FlattenReplicationRuleFilterAndOperator 

func FlattenReplicationRuleFilterAndOperator(op *s3.ReplicationRuleAndOperator) []interface{}

func FlattenReplicationRuleFilterTag 

func FlattenReplicationRuleFilterTag(tag *s3.Tag) []interface{}

func FlattenReplicationRuleSourceSelectionCriteria 

func FlattenReplicationRuleSourceSelectionCriteria(ssc *s3.SourceSelectionCriteria) []interface{}

func FlattenReplicationRules 

func FlattenReplicationRules(rules []*s3.ReplicationRule) []interface{}

func FlattenSourceSelectionCriteriaReplicaModifications 

func FlattenSourceSelectionCriteriaReplicaModifications(rc *s3.ReplicaModifications) []interface{}

func FlattenSourceSelectionCriteriaSSEKMSEncryptedObjects 

func FlattenSourceSelectionCriteriaSSEKMSEncryptedObjects(objects *s3.SseKmsEncryptedObjects) []interface{}

func FlattenStorageClassAnalysis 

func FlattenStorageClassAnalysis(storageClassAnalysis *s3.StorageClassAnalysis) []map[string]interface{}

func HostedZoneIDForRegion 

func HostedZoneIDForRegion(region string) (string, error)

Returns the hosted zone ID for an S3 website endpoint region. This can be used as input to the aws_route53_record resource's zone_id argument.

func KeyValueTags 

func KeyValueTags(tags []*s3.Tag) tftags.KeyValueTags

KeyValueTags creates tftags.KeyValueTags from s3 service tags.

func ObjectListTags 

func ObjectListTags(conn *s3.S3, bucket, key string) (tftags.KeyValueTags, error)

ObjectListTags lists S3 object tags.

func ObjectUpdateTags 

func ObjectUpdateTags(conn *s3.S3, bucket, key string, oldTagsMap interface{}, newTagsMap interface{}) error

ObjectUpdateTags updates S3 object tags.

func ParseResourceID 

func ParseResourceID(id string) (bucket, expectedBucketOwner string, err error)

ParseResourceID is a generic method for parsing an ID string for a bucket name and accountID if provided.

func ResourceBucket 

func ResourceBucket() *schema.Resource

func ResourceBucketACL 

func ResourceBucketACL() *schema.Resource

func ResourceBucketAccelerateConfiguration 

func ResourceBucketAccelerateConfiguration() *schema.Resource

func ResourceBucketAnalyticsConfiguration 

func ResourceBucketAnalyticsConfiguration() *schema.Resource

func ResourceBucketCorsConfiguration 

func ResourceBucketCorsConfiguration() *schema.Resource

func ResourceBucketIntelligentTieringConfiguration 

func ResourceBucketIntelligentTieringConfiguration() *schema.Resource

func ResourceBucketInventory 

func ResourceBucketInventory() *schema.Resource

func ResourceBucketLifecycleConfiguration 

func ResourceBucketLifecycleConfiguration() *schema.Resource

func ResourceBucketLogging 

func ResourceBucketLogging() *schema.Resource

func ResourceBucketMetric 

func ResourceBucketMetric() *schema.Resource

func ResourceBucketNotification 

func ResourceBucketNotification() *schema.Resource

func ResourceBucketObject 

func ResourceBucketObject() *schema.Resource

func ResourceBucketObjectLockConfiguration 

func ResourceBucketObjectLockConfiguration() *schema.Resource

func ResourceBucketOwnershipControls 

func ResourceBucketOwnershipControls() *schema.Resource

func ResourceBucketPolicy 

func ResourceBucketPolicy() *schema.Resource

func ResourceBucketPublicAccessBlock 

func ResourceBucketPublicAccessBlock() *schema.Resource

func ResourceBucketReplicationConfiguration 

func ResourceBucketReplicationConfiguration() *schema.Resource

func ResourceBucketRequestPaymentConfiguration 

func ResourceBucketRequestPaymentConfiguration() *schema.Resource

func ResourceBucketServerSideEncryptionConfiguration 

func ResourceBucketServerSideEncryptionConfiguration() *schema.Resource

func ResourceBucketVersioning 

func ResourceBucketVersioning() *schema.Resource

func ResourceBucketWebsiteConfiguration 

func ResourceBucketWebsiteConfiguration() *schema.Resource

func ResourceObject 

func ResourceObject() *schema.Resource

func ResourceObjectCopy 

func ResourceObjectCopy() *schema.Resource

func Tags 

func Tags(tags tftags.KeyValueTags) []*s3.Tag

Tags returns s3 service tags.

func ValidBucketName 

func ValidBucketName(value string, region string) error

ValidBucketName validates any S3 bucket name that is not inside the us-east-1 region. Buckets outside of this region have to be DNS-compliant. After the same restrictions are applied to buckets in the us-east-1 region, this function can be refactored as a SchemaValidateFunc

func WaitForDeleteBucketAnalyticsConfiguration 

func WaitForDeleteBucketAnalyticsConfiguration(conn *s3.S3, bucket, name string, timeout time.Duration) error

func WebsiteDomainURL 

func WebsiteDomainURL(client *conns.AWSClient, region string) string

Types

type S3Website 

type S3Website struct {
	Endpoint, Domain string
}

func WebsiteEndpoint 

func WebsiteEndpoint(client *conns.AWSClient, bucket string, region string) *S3Website

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.