Header menu logo FsCDK

SSMParameterBuilder Type

Constructors

Constructor Description

SSMParameterBuilder(name)

Full Usage: SSMParameterBuilder(name)

Parameters:
    name : string

Returns: SSMParameterBuilder
name : string
Returns: SSMParameterBuilder

Instance members

Instance member Description

allowedPattern pattern

Full Usage: allowedPattern pattern

Parameters:
    pattern : string - The allowed pattern to store

Returns: SSMParameterConfig

Sets the allowed pattern for the SSM Parameter.

pattern : string

The allowed pattern to store

Returns: SSMParameterConfig

this.Combine

Full Usage: this.Combine

Parameters:
Returns: SSMParameterConfig
state1 : SSMParameterConfig
state2 : SSMParameterConfig
Returns: SSMParameterConfig

constructId id

Full Usage: constructId id

Parameters:
    id : string - The construct ID to set

Returns: SSMParameterConfig

Sets the construct ID for the underlying CDK StringParameter construct.

id : string

The construct ID to set

Returns: SSMParameterConfig

dataType dataType

Full Usage: dataType dataType

Parameters:
Returns: SSMParameterConfig

Sets the data type for the SSM Parameter.

dataType : ParameterDataType

The data type to store

Returns: SSMParameterConfig

this.Delay

Full Usage: this.Delay

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

description description

Full Usage: description description

Parameters:
    description : string - The description to store

Returns: SSMParameterConfig

Sets the description for the SSM Parameter.

description : string

The description to store

Returns: SSMParameterConfig

this.For

Full Usage: this.For

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

this.Run

Full Usage: this.Run

Parameters:
Returns: SSMParameterSpec
config : SSMParameterConfig
Returns: SSMParameterSpec

simpleName simpleName

Full Usage: simpleName simpleName

Parameters:
    simpleName : bool - Whether the SSM Parameter should be a simple name

Returns: SSMParameterConfig

Sets whether the SSM Parameter should be a simple name.

simpleName : bool

Whether the SSM Parameter should be a simple name

Returns: SSMParameterConfig

stringValue value

Full Usage: stringValue value

Parameters:
    value : string - The string value to store

Returns: SSMParameterConfig

Sets the string value for the SSM Parameter.

value : string

The string value to store

Returns: SSMParameterConfig

tier tier

Full Usage: tier tier

Parameters:
Returns: SSMParameterConfig

Sets the parameter tier for the SSM Parameter.

tier : ParameterTier

The parameter tier to store

Returns: SSMParameterConfig

this.Yield

Full Usage: this.Yield

Parameters:
    () : unit

Returns: SSMParameterConfig
() : unit
Returns: SSMParameterConfig

this.Zero

Full Usage: this.Zero

Returns: SSMParameterConfig
Returns: SSMParameterConfig

Type something to start searching.