API.md

API Reference

Constructs

ManagedInstanceRole

Initializers

import { ManagedInstanceRole } from '@renovosolutions/cdk-library-managed-instance-role'

new ManagedInstanceRole(scope: Construct, id: string, props: ManagedInstanceRoleProps)

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: @renovosolutions/cdk-library-managed-instance-role.ManagedInstanceRoleProps

---

Properties

arn^Required

public readonly arn: string;

• Type: string

The role arn.

---

name^Required

public readonly name: string;

• Type: string

The role name.

---

role^Required

public readonly role: Role;

• Type: aws-cdk-lib.aws_iam.Role

The role.

---

instanceProfile^Optional

public readonly instanceProfile: CfnInstanceProfile;

• Type: aws-cdk-lib.aws_iam.CfnInstanceProfile

The CfnInstanceProfile automatically created for this role.

---

Structs

ManagedInstanceRoleProps

Initializer

import { ManagedInstanceRoleProps } from '@renovosolutions/cdk-library-managed-instance-role'

const managedInstanceRoleProps: ManagedInstanceRoleProps = { ... }

createInstanceProfile^Optional

public readonly createInstanceProfile: boolean;

• Type: boolean
• Default: true

Whether or not to associate the role with an instance profile.

---

domainJoinEnabled^Optional

public readonly domainJoinEnabled: boolean;

• Type: boolean

Should the role include directory service access with SSM.

---

managedPolicies^Optional

public readonly managedPolicies: ManagedPolicy[];

• Type: aws-cdk-lib.aws_iam.ManagedPolicy[]

The managed policies to apply to the role in addition to the default policies.

---

retentionPolicy^Optional

public readonly retentionPolicy: boolean;

• Type: boolean

The retention policy for this role.

---

ssmManagementEnabled^Optional

public readonly ssmManagementEnabled: boolean;

• Type: boolean

Should the role include SSM management.

By default if domainJoinEnabled is true then this role is always included.

---