Skip to content

Latest commit

 

History

History
213 lines (124 loc) · 7.08 KB

API.md

File metadata and controls

213 lines (124 loc) · 7.08 KB
Raw

API Reference

Constructs

IamCredentialsRotator

Initializers 

import { IamCredentialsRotator } from 'cdk-iam-credentials-rotator'

new IamCredentialsRotator(scope: Construct, id: string, props: IIamCredentialsRotatorProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props IIamCredentialsRotatorProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { IamCredentialsRotator } from 'cdk-iam-credentials-rotator'

IamCredentialsRotator.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

Protocols

IIamCredentialsRotatorProps

Properties

Name Type Description
credentialsHandler aws-cdk-lib.aws_lambda.IFunction Lambda function which is invoked after new credentials are created for a user.
users IUser[] List of users to rotate credentials for in the target account.
cleanupWaitDuration aws-cdk-lib.Duration The amount of time to wait before deleting old credentials.
scheduleDuration aws-cdk-lib.Duration Frequency of key rotation.
credentialsHandlerRequired 
public readonly credentialsHandler: IFunction;
  • Type: aws-cdk-lib.aws_lambda.IFunction

Lambda function which is invoked after new credentials are created for a user.

usersRequired 
public readonly users: IUser[];

List of users to rotate credentials for in the target account.

cleanupWaitDurationOptional 
public readonly cleanupWaitDuration: Duration;
  • Type: aws-cdk-lib.Duration
  • Default: 5 minutes

The amount of time to wait before deleting old credentials.

This value MUST be significantly less-than scheduleDuration.

scheduleDurationOptional 
public readonly scheduleDuration: Duration;
  • Type: aws-cdk-lib.Duration
  • Default: 1 hour

Frequency of key rotation.

IUser

Properties

Name Type Description
username string Username of an IAM user in the target account.
metadata string Optional metadata.
usernameRequired 
public readonly username: string;
  • Type: string

Username of an IAM user in the target account.

metadataOptional 
public readonly metadata: string;
  • Type: string

Optional metadata.