# API Reference
## Constructs
### SSMSecureIAMAccessKey
Custom resource that creates a new IAM access key for the given user, then stores the AccessKeyId and Secret in a SSM SecureString Parameter.
> [IAMAccessKey * Example: { "accessKeyId": "AKIAXXXXXXXXXXXXXXXX", "secretAccessKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" }
Give permission to use this secret SSM Parameter:
ssm.StringParameter.fromSecureStringParameterAttributes(this, "ID", {
parameterName: this.props.parameterName,
});](IAMAccessKey * Example: { "accessKeyId": "AKIAXXXXXXXXXXXXXXXX", "secretAccessKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" }
Give permission to use this secret SSM Parameter:
ssm.StringParameter.fromSecureStringParameterAttributes(this, "ID", {
parameterName: this.props.parameterName,
});)
#### Initializers
```typescript
import { SSMSecureIAMAccessKey } from 'cdk-ssm-secure-iam-access-key'
new SSMSecureIAMAccessKey(scope: Construct, id: string, props: ISSMSecureIAMAccessKeyProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | ISSMSecureIAMAccessKeyProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* ISSMSecureIAMAccessKeyProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### ~~`isConstruct`~~
```typescript
import { SSMSecureIAMAccessKey } from 'cdk-ssm-secure-iam-access-key'
SSMSecureIAMAccessKey.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
## Protocols
### IAMAccessKey
- *Implemented By:* IAMAccessKey
The IAMAccessKey created is stored JSON.stringified using this interface.
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| accessKeyId | string | *No description.* |
| secretAccessKey | string | *No description.* |
---
##### `accessKeyId`Required
```typescript
public readonly accessKeyId: string;
```
- *Type:* string
---
##### `secretAccessKey`Required
```typescript
public readonly secretAccessKey: string;
```
- *Type:* string
---
### ISSMSecureIAMAccessKeyProps
- *Implemented By:* ISSMSecureIAMAccessKeyProps
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| parameterName | string | *No description.* |
| user | aws-cdk-lib.aws_iam.IUser | *No description.* |
| region | string | *No description.* |
---
##### `parameterName`Required
```typescript
public readonly parameterName: string;
```
- *Type:* string
---
##### `user`Required
```typescript
public readonly user: IUser;
```
- *Type:* aws-cdk-lib.aws_iam.IUser
---
##### `region`Optional
```typescript
public readonly region: string;
```
- *Type:* string
---