Header menu logo FsCDK

BucketBuilder Type

Constructors

Constructor Description

BucketBuilder(name)

Full Usage: BucketBuilder(name)

Parameters:
    name : string

Returns: BucketBuilder
name : string
Returns: BucketBuilder

Instance members

Instance member Description

autoDeleteObjects enabled

Full Usage: autoDeleteObjects enabled

Parameters:
    enabled : bool

Returns: BucketConfig
enabled : bool
Returns: BucketConfig

blockPublicAccess value

Full Usage: blockPublicAccess value

Parameters:
Returns: BucketConfig
value : BlockPublicAccess
Returns: BucketConfig

this.Combine

Full Usage: this.Combine

Parameters:
Returns: BucketConfig
state1 : BucketConfig
state2 : BucketConfig
Returns: BucketConfig

constructId id

Full Usage: constructId id

Parameters:
    id : string

Returns: BucketConfig
id : string
Returns: BucketConfig

this.Delay

Full Usage: this.Delay

Parameters:
Returns: BucketConfig
Modifiers: inline
f : unit -> BucketConfig
Returns: BucketConfig

encryption value

Full Usage: encryption value

Parameters:
Returns: BucketConfig
value : BucketEncryption
Returns: BucketConfig

encryptionKey key

Full Usage: encryptionKey key

Parameters:
Returns: BucketConfig
key : IKey
Returns: BucketConfig

enforceSSL value

Full Usage: enforceSSL value

Parameters:
    value : bool

Returns: BucketConfig
value : bool
Returns: BucketConfig

this.For

Full Usage: this.For

Parameters:
Returns: BucketConfig
Modifiers: inline
config : BucketConfig
f : unit -> BucketConfig
Returns: BucketConfig

removalPolicy value

Full Usage: removalPolicy value

Parameters:
Returns: BucketConfig
value : RemovalPolicy
Returns: BucketConfig

this.Run

Full Usage: this.Run

Parameters:
Returns: BucketSpec
config : BucketConfig
Returns: BucketSpec

serverAccessLogsBucket bucket

Full Usage: serverAccessLogsBucket bucket

Parameters:
Returns: BucketConfig
bucket : IBucket
Returns: BucketConfig

serverAccessLogsPrefix prefix

Full Usage: serverAccessLogsPrefix prefix

Parameters:
    prefix : string

Returns: BucketConfig
prefix : string
Returns: BucketConfig

versioned value

Full Usage: versioned value

Parameters:
    value : bool - True to enable versioning, false to disable.

Returns: BucketConfig

Enables or disables versioning for the S3 bucket. **Security Best Practice:** Enable versioning for: - Critical data that requires audit trails - Data subject to compliance requirements (HIPAA, SOC2, etc.) - Production buckets storing business data **Cost Consideration:** Versioning stores all versions of objects, increasing storage costs. Only disable for: - Temporary/cache buckets - Build artifacts with short lifecycle - Development/testing buckets **Default:** false (opt-in for cost optimization)

value : bool

True to enable versioning, false to disable.

Returns: BucketConfig

websiteErrorDocument doc

Full Usage: websiteErrorDocument doc

Parameters:
    doc : string

Returns: BucketConfig
doc : string
Returns: BucketConfig

websiteIndexDocument doc

Full Usage: websiteIndexDocument doc

Parameters:
    doc : string

Returns: BucketConfig
doc : string
Returns: BucketConfig

this.Yield

Full Usage: this.Yield

Parameters:
Returns: BucketConfig
metrics : IBucketMetrics
Returns: BucketConfig

this.Yield

Full Usage: this.Yield

Parameters:
Returns: BucketConfig
lifecycleRule : ILifecycleRule
Returns: BucketConfig

this.Yield

Full Usage: this.Yield

Parameters:
Returns: BucketConfig
corsRule : ICorsRule
Returns: BucketConfig

this.Yield

Full Usage: this.Yield

Parameters:
    () : unit

Returns: BucketConfig
() : unit
Returns: BucketConfig

this.Zero

Full Usage: this.Zero

Returns: BucketConfig
Returns: BucketConfig

Type something to start searching.