Header menu logo FsCDK

SSMDocumentBuilder Type

Constructors

Constructor Description

SSMDocumentBuilder(name)

Full Usage: SSMDocumentBuilder(name)

Parameters:
    name : string

Returns: SSMDocumentBuilder
name : string
Returns: SSMDocumentBuilder

Instance members

Instance member Description

attachments attachments

Full Usage: attachments attachments

Parameters:
    attachments : obj - The attachments to set

Returns: SSMDocumentConfig

Sets the attachments for the SSM Document.

attachments : obj

The attachments to set

Returns: SSMDocumentConfig

this.Combine

Full Usage: this.Combine

Parameters:
Returns: SSMDocumentConfig
state1 : SSMDocumentConfig
state2 : SSMDocumentConfig
Returns: SSMDocumentConfig

constructId id

Full Usage: constructId id

Parameters:
    id : string - The construct ID to set

Returns: SSMDocumentConfig

Sets the construct ID for the underlying CDK CfnDocument construct.

id : string

The construct ID to set

Returns: SSMDocumentConfig

content content

Full Usage: content content

Parameters:
    content : obj - The content to store

Returns: SSMDocumentConfig

Sets the content for the SSM Document.

content : obj

The content to store

Returns: SSMDocumentConfig

this.Delay

Full Usage: this.Delay

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

documentFormat format

Full Usage: documentFormat format

Parameters:
    format : string - The document format to store

Returns: SSMDocumentConfig

Sets the document format for the SSM Document.

format : string

The document format to store

Returns: SSMDocumentConfig

documentType docType

Full Usage: documentType docType

Parameters:
    docType : string - The document type to store

Returns: SSMDocumentConfig

Sets the document type and format for the SSM Document.

docType : string

The document type to store

Returns: SSMDocumentConfig

this.For

Full Usage: this.For

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

requires requires

Full Usage: requires requires

Parameters:
    requires : obj - The requires to set

Returns: SSMDocumentConfig

Sets the requires for the SSM Document.

requires : obj

The requires to set

Returns: SSMDocumentConfig

this.Run

Full Usage: this.Run

Parameters:
Returns: SSMDocumentSpec
config : SSMDocumentConfig
Returns: SSMDocumentSpec

tag tag

Full Usage: tag tag

Parameters:
Returns: SSMDocumentConfig

Adds a tag to the SSM Document.

tag : ICfnTag

The tag to add

Returns: SSMDocumentConfig

tags tags

Full Usage: tags tags

Parameters:
    tags : ICfnTag list - The tags to set

Returns: SSMDocumentConfig

Sets tags for the SSM Document.

tags : ICfnTag list

The tags to set

Returns: SSMDocumentConfig

targetType targetType

Full Usage: targetType targetType

Parameters:
    targetType : string - The target type to store

Returns: SSMDocumentConfig

Sets the target type for the SSM Document.

targetType : string

The target type to store

Returns: SSMDocumentConfig

updateMethod updateMethod

Full Usage: updateMethod updateMethod

Parameters:
    updateMethod : string - The update method to set

Returns: SSMDocumentConfig

Sets the update method for the SSM Document.

updateMethod : string

The update method to set

Returns: SSMDocumentConfig

versionName versionName

Full Usage: versionName versionName

Parameters:
    versionName : string - The version name to set

Returns: SSMDocumentConfig

Sets the version name for the SSM Document.

versionName : string

The version name to set

Returns: SSMDocumentConfig

this.Yield

Full Usage: this.Yield

Parameters:
    () : unit

Returns: SSMDocumentConfig
() : unit
Returns: SSMDocumentConfig

this.Zero

Full Usage: this.Zero

Returns: SSMDocumentConfig
Returns: SSMDocumentConfig

Type something to start searching.