Skip to content

Latest commit

 

History

History
50 lines (29 loc) · 3 KB

API.md

File metadata and controls

50 lines (29 loc) · 3 KB

API Reference

Classes

Name Description
SesUser Define a new IAM user and generates the SES credentials.

class SesUser

Define a new IAM user and generates the SES credentials.

Implements: IConstruct, IConstruct, IConstruct, IDependable, IResource, IConstruct, IDependable, IConstruct, IIdentity, IGrantable, IPrincipal, IConstruct, IDependable, IConstruct, IResource, IUser, IGrantable, IPrincipal, IConstruct, IDependable, IConstruct, IResource, IIdentity Extends: User

Initializer

new SesUser(scope: Construct, id: string, props?: UserProps)
  • scope (Construct) No description
  • id (string) No description
  • props (UserProps) No description
    • groups (Array<IGroup>) Groups to add this user to. Default: No groups.
    • managedPolicies (Array<IManagedPolicy>) A list of managed policies associated with this role. Default: No managed policies.
    • password (SecretValue) The password for the user. This is required so the user can access the AWS Management Console. Default: User won't be able to access the management console without a password.
    • passwordResetRequired (boolean) Specifies whether the user is required to set a new password the next time the user logs in to the AWS Management Console. Default: false
    • path (string) The path for the user name. Default: /
    • permissionsBoundary (IManagedPolicy) AWS supports permissions boundaries for IAM entities (users or roles). Default: No permissions boundary.
    • userName (string) A name for the IAM user. Default: Generated by CloudFormation (recommended)

Properties

Name Type Description
accessKey string An attribute that represents the user access_key.
secretKey string An attribute that represents the user secret_key.
smtpPassword string An attribute that represents the user smtp password.