Header menu logo FsCDK

FargateTaskDefinitionBuilder Type

Constructors

Constructor Description

FargateTaskDefinitionBuilder(name)

Full Usage: FargateTaskDefinitionBuilder(name)

Parameters:
    name : string

Returns: FargateTaskDefinitionBuilder
name : string
Returns: FargateTaskDefinitionBuilder

Instance members

Instance member Description

this.Combine

Full Usage: this.Combine

Parameters:
Returns: FargateTaskDefinitionConfig
state1 : FargateTaskDefinitionConfig
state2 : FargateTaskDefinitionConfig
Returns: FargateTaskDefinitionConfig

constructId id

Full Usage: constructId id

Parameters:
    id : string

Returns: FargateTaskDefinitionConfig

Sets a custom construct ID.

id : string
Returns: FargateTaskDefinitionConfig

cpu cpu

Full Usage: cpu cpu

Parameters:
    cpu : int

Returns: FargateTaskDefinitionConfig

Sets the number of CPU units (256, 512, 1024, 2048, 4096).

cpu : int
Returns: FargateTaskDefinitionConfig

this.Delay

Full Usage: this.Delay

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

ephemeralStorageGiB size

Full Usage: ephemeralStorageGiB size

Parameters:
    size : int

Returns: FargateTaskDefinitionConfig

Sets the ephemeral storage size in GiB (default 20, max 200).

size : int
Returns: FargateTaskDefinitionConfig

executionRole role

Full Usage: executionRole role

Parameters:
Returns: FargateTaskDefinitionConfig

Sets the IAM role for the execution (pulls images, writes logs).

role : IRole
Returns: FargateTaskDefinitionConfig

family family

Full Usage: family family

Parameters:
    family : string

Returns: FargateTaskDefinitionConfig

Sets the task definition family name.

family : string
Returns: FargateTaskDefinitionConfig

this.For

Full Usage: this.For

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

memory memory

Full Usage: memory memory

Parameters:
    memory : int

Returns: FargateTaskDefinitionConfig

Sets the memory limit in MiB.

memory : int
Returns: FargateTaskDefinitionConfig

this.Run

Full Usage: this.Run

Parameters:
Returns: FargateTaskDefinitionSpec
config : FargateTaskDefinitionConfig
Returns: FargateTaskDefinitionSpec

runtimePlatform platform

Full Usage: runtimePlatform platform

Parameters:
Returns: FargateTaskDefinitionConfig

Sets the runtime platform (CPU architecture and OS).

platform : RuntimePlatform
Returns: FargateTaskDefinitionConfig

taskRole role

Full Usage: taskRole role

Parameters:
Returns: FargateTaskDefinitionConfig

Sets the IAM role for the task (application permissions).

role : IRole
Returns: FargateTaskDefinitionConfig

volume volume

Full Usage: volume volume

Parameters:
Returns: FargateTaskDefinitionConfig

Adds a volume to the task definition.

volume : Volume
Returns: FargateTaskDefinitionConfig

volumes volumes

Full Usage: volumes volumes

Parameters:
Returns: FargateTaskDefinitionConfig

Adds multiple volumes to the task definition.

volumes : Volume list
Returns: FargateTaskDefinitionConfig

this.Yield

Full Usage: this.Yield

Parameters:
    () : unit

Returns: FargateTaskDefinitionConfig
() : unit
Returns: FargateTaskDefinitionConfig

this.Zero

Full Usage: this.Zero

Returns: FargateTaskDefinitionConfig
Returns: FargateTaskDefinitionConfig

Type something to start searching.