Skip to main content

IamUserSchema

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

@group

Resources/IamUser

@overrideProperty

parents - This resource has no parents.

@overrideProperty

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

Hierarchy

  • BaseResourceSchema
    • IamUserSchema

Index

Properties

Properties

inheritedparents

parents: IResourceReference[]

properties

properties: { awsAccountId: string; policies: { policy: IIamUserS3BucketPolicy; policyId: string; policyType: s3-storage-access-policy }[]; username: string } = ...

Input properties.

  • properties.awsAccountId: The AWS account ID.
  • properties.policies: The policies to attach to the user. See IIamUserPolicyTypes for options.
  • properties.username: The name of the user to create.

Type declaration

  • awsAccountId: string
  • policies: { policy: IIamUserS3BucketPolicy; policyId: string; policyType: s3-storage-access-policy }[]
  • username: string

inheritedresourceId

resourceId: string

response

response: { Arn?: string; policies?: {}; UserId?: string; UserName?: string } = ...

Saved response.

  • response.Arn: The ARN of the user.
  • response.policies: A map of policy IDs to policy ARNs.
  • response.UserId: The ID of the user.
  • response.UserName: The name of the user.

Type declaration

  • optionalArn?: string
  • optionalpolicies?: {}
    • [key string]: string[]
  • optionalUserId?: string
  • optionalUserName?: string

inheritedtags

tags: {}

Type declaration

  • [key string]: string
Page Options