Skip to main content

IamRoleSchema

The IamRoleSchema class is the schema for the IamRole resource, which represents the AWS Identity and Access Management (IAM) Role resource. This resource can create a iam role in AWS using the AWS JavaScript SDK V3 API. See official sdk docs.

@group

Resources/IamRole

@overrideProperty

parents - This resource has no parents.

@overrideProperty

resourceId - The resource id is of format iam-role-<role-name>

Hierarchy

  • BaseResourceSchema
    • IamRoleSchema

Index

Properties

Properties

inheritedparents

parents: IResourceReference[]

properties

properties: { awsAccountId: string; policies: ({ policy: IIamRoleS3BucketPolicy; policyId: string; policyType: s3-storage-access-policy } | { policy: ecs-tasks.amazonaws.com; policyId: string; policyType: assume-role-policy } | { policy: string; policyId: string; policyType: aws-policy })[]; rolename: string } = ...

Input properties.

  • properties.awsAccountId: The AWS account ID.
  • properties.policies: The policies to attach to the role. See IIamRolePolicyTypes for options.
  • properties.rolename: The name of the role to create.

Type declaration

  • awsAccountId: string
  • policies: ({ policy: IIamRoleS3BucketPolicy; policyId: string; policyType: s3-storage-access-policy } | { policy: ecs-tasks.amazonaws.com; policyId: string; policyType: assume-role-policy } | { policy: string; policyId: string; policyType: aws-policy })[]
  • rolename: string

inheritedresourceId

resourceId: string

response

response: { Arn?: string; policies?: {}; RoleId?: string; RoleName?: string } = ...

Saved response.

  • response.Arn: The ARN of the role.
  • response.policies: A map of policy IDs to policy ARNs.
  • response.RoleId: The ID of the role.
  • response.RoleName: The name of the role.

Type declaration

  • optionalArn?: string
  • optionalpolicies?: {}
    • [key string]: string[]
  • optionalRoleId?: string
  • optionalRoleName?: string

inheritedtags

tags: {}

Type declaration

  • [key string]: string
Page Options