Header menu logo FsCDK

RoleBuilder Type

Constructors

Constructor Description

RoleBuilder(name)

Full Usage: RoleBuilder(name)

Parameters:
    name : string

Returns: RoleBuilder
name : string
Returns: RoleBuilder

Instance members

Instance member Description

addToPolicies statements

Full Usage: addToPolicies statements

Parameters:
Returns: RoleConfig

Adds statements to the role's policy.

statements : PolicyStatement list

The sequence of statements to add.

Returns: RoleConfig

addToPolicy statement

Full Usage: addToPolicy statement

Parameters:
Returns: RoleConfig

Adds a statement to the role's policy.

statement : PolicyStatement

The statement to add.

Returns: RoleConfig

assumedBy principal

Full Usage: assumedBy principal

Parameters:
Returns: RoleConfig

Sets the principal that can assume the role.

principal : IPrincipal

The IAM principal.

Returns: RoleConfig

this.Combine

Full Usage: this.Combine

Parameters:
Returns: RoleConfig
state1 : RoleConfig
state2 : RoleConfig
Returns: RoleConfig

constructId id

Full Usage: constructId id

Parameters:
    id : string - The construct ID.

Returns: RoleConfig

Sets the construct ID for the role.

id : string

The construct ID.

Returns: RoleConfig

this.Delay

Full Usage: this.Delay

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

description description

Full Usage: description description

Parameters:
    description : string - The role description.

Returns: RoleConfig

Sets the description for the role.

description : string

The role description.

Returns: RoleConfig

externalIds externalIds

Full Usage: externalIds externalIds

Parameters:
    externalIds : string list - The sequence of external IDs.

Returns: RoleConfig

Adds external IDs for the role trust policy.

externalIds : string list

The sequence of external IDs.

Returns: RoleConfig

this.For

Full Usage: this.For

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

inlinePolicies policies

Full Usage: inlinePolicies policies

Parameters:
    policies : (string * PolicyDocument) list - A tuple of policy name and policy document.

Returns: RoleConfig

Adds an inline policy to the role.

policies : (string * PolicyDocument) list

A tuple of policy name and policy document.

Returns: RoleConfig

managedPolicies managedPolicies

Full Usage: managedPolicies managedPolicies

Parameters:
    managedPolicies : IManagedPolicy list - The sequence of managed policies.

Returns: RoleConfig

Adds managed policies to the role.

managedPolicies : IManagedPolicy list

The sequence of managed policies.

Returns: RoleConfig

managedPolicy managedPolicy

Full Usage: managedPolicy managedPolicy

Parameters:
Returns: RoleConfig

Adds managed policies to the role.

managedPolicy : IManagedPolicy

The managed policy.

Returns: RoleConfig

maxSessionDuration duration

Full Usage: maxSessionDuration duration

Parameters:
    duration : Duration - The maximum session duration.

Returns: RoleConfig

Sets the maximum session duration for the role.

duration : Duration

The maximum session duration.

Returns: RoleConfig

path path

Full Usage: path path

Parameters:
    path : string - The role path.

Returns: RoleConfig

Sets the path for the role.

path : string

The role path.

Returns: RoleConfig

permissionsBoundary boundary

Full Usage: permissionsBoundary boundary

Parameters:
    boundary : IManagedPolicy - The managed policy to use as the permissions boundary.

Returns: RoleConfig

Sets the permissions boundary for the role.

boundary : IManagedPolicy

The managed policy to use as the permissions boundary.

Returns: RoleConfig

this.Run

Full Usage: this.Run

Parameters:
Returns: RoleSpec
config : RoleConfig
Returns: RoleSpec

this.Yield

Full Usage: this.Yield

Parameters:
Returns: RoleConfig
managedPolicy : IManagedPolicy
Returns: RoleConfig

this.Yield

Full Usage: this.Yield

Parameters:
Returns: RoleConfig
policyStatement : PolicyStatement
Returns: RoleConfig

this.Yield

Full Usage: this.Yield

Parameters:
Returns: RoleConfig
principal : IPrincipal
Returns: RoleConfig

this.Yield

Full Usage: this.Yield

Parameters:
    () : unit

Returns: RoleConfig
() : unit
Returns: RoleConfig

this.Zero

Full Usage: this.Zero

Returns: RoleConfig
Returns: RoleConfig

Type something to start searching.