bucket

Documentation

Overview

bucket

Index

• func Bucket_IsConstruct(x interface{}) *bool
• func Bucket_IsTerraformElement(x interface{}) *bool
• func NewBucket_Override(b Bucket, scope constructs.Construct, id *string, config *BucketConfig)
• type Bucket
  • func NewBucket(scope constructs.Construct, id *string, config *BucketConfig) Bucket
• type BucketConfig

Functions

func Bucket_IsConstruct

func Bucket_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func Bucket_IsTerraformElement

func Bucket_IsTerraformElement(x interface{}) *bool

Experimental.

func NewBucket_Override

func NewBucket_Override(b Bucket, scope constructs.Construct, id *string, config *BucketConfig)

Types

type Bucket

type Bucket interface {
	cdktf.TerraformModule
	BucketLocationOutput() *string
	BucketName() *string
	SetBucketName(val *string)
	BucketStorageClassOutput() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	NameOutput() *string
	// The tree node.
	Node() constructs.Node
	NotificationTargets() interface{}
	SetNotificationTargets(val interface{})
	// Experimental.
	Providers() *[]interface{}
	// Experimental.
	RawOverrides() interface{}
	// Experimental.
	SkipAssetCreationFromLocalModules() *bool
	// Experimental.
	Source() *string
	StackId() *string
	SetStackId(val *string)
	StorageClass() *string
	SetStorageClass(val *string)
	// Experimental.
	Version() *string
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	AddProvider(provider interface{})
	// Experimental.
	GetString(output *string) *string
	// Experimental.
	InterpolationForOutput(moduleOutput *string) cdktf.IResolvable
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	SynthesizeHclAttributes() *map[string]interface{}
	// Experimental.
	ToHclTerraform() interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Experimental.
	ToTerraform() interface{}
}

Defines an Bucket based on a Terraform module.

Source at ./.nitric/modules/bucket

func NewBucket

func NewBucket(scope constructs.Construct, id *string, config *BucketConfig) Bucket

type BucketConfig

type BucketConfig struct {
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Providers *[]interface{} `field:"optional" json:"providers" yaml:"providers"`
	// Experimental.
	SkipAssetCreationFromLocalModules *bool `field:"optional" json:"skipAssetCreationFromLocalModules" yaml:"skipAssetCreationFromLocalModules"`
	// The name of the bucket.
	//
	// This must be globally unique.
	BucketName *string `field:"required" json:"bucketName" yaml:"bucketName"`
	// The notification target configurations.
	NotificationTargets interface{} `field:"required" json:"notificationTargets" yaml:"notificationTargets"`
	// The ID of the Nitric stack.
	StackId *string `field:"required" json:"stackId" yaml:"stackId"`
	// The class of storage used to store the bucket's contents.
	//
	// This can be STANDARD, NEARLINE, COLDLINE, ARCHIVE, or MULTI_REGIONAL.
	// STANDARD.
	StorageClass *string `field:"optional" json:"storageClass" yaml:"storageClass"`
}