package s3bucket

import "github.com/oslokommune/okctl/pkg/cfn/components/s3bucket"

Package s3bucket knows how to create an AWS S3 bucket cloud formation resource

Index ¶

• type S3Bucket
• func New(resourceName, bucketName string, encrypt bool, versioning bool) *S3Bucket
• func (s *S3Bucket) Name() string
• func (s *S3Bucket) NamedOutputs() map[string]cloudformation.Output
• func (s *S3Bucket) Ref() string
• func (s *S3Bucket) Resource() cloudformation.Resource

Types ¶

type S3Bucket ¶

type S3Bucket struct {
	StoredName           string
	BucketName           string
	BlockAllPublicAccess bool
	Encrypt              bool
	Versioning           bool
}

S3Bucket contains the state required for building the cloud formation template

func New ¶

func New(resourceName, bucketName string, encrypt bool, versioning bool) *S3Bucket

New returns an initialised AWS S3 cloud formation template - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html

func (*S3Bucket) Name ¶

func (s *S3Bucket) Name() string

Name returns the name of the resource

func (*S3Bucket) NamedOutputs ¶

func (s *S3Bucket) NamedOutputs() map[string]cloudformation.Output

NamedOutputs returns the named outputs

func (*S3Bucket) Ref ¶

func (s *S3Bucket) Ref() string

Ref returns an AWS intrinsic ref to the resource

func (*S3Bucket) Resource ¶

func (s *S3Bucket) Resource() cloudformation.Resource

Resource returns the cloud formation template

Source Files ¶

s3bucket.go