# API Reference
## Constructs
### Ec2RequiredPolicyConfigRule
#### Initializers
```typescript
import { Ec2RequiredPolicyConfigRule } from 'ec2-required-policy-config-rule'
new Ec2RequiredPolicyConfigRule(scope: IConstruct, id: string, props: Ec2RequiredPolicyConfigRuleProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.IConstruct | *No description.* |
| id | string | *No description.* |
| props | Ec2RequiredPolicyConfigRuleProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.IConstruct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* Ec2RequiredPolicyConfigRuleProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
| applyRemovalPolicy | Apply the given removal policy to this resource. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `applyRemovalPolicy`
```typescript
public applyRemovalPolicy(policy: RemovalPolicy): void
```
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops
being managed by CloudFormation, either because you've removed it from the
CDK application or because you've made a change that requires the resource
to be replaced.
The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
###### `policy`Required
- *Type:* aws-cdk-lib.RemovalPolicy
---
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
| isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. |
| isResource | Check whether the given construct is a Resource. |
---
##### ~~`isConstruct`~~
```typescript
import { Ec2RequiredPolicyConfigRule } from 'ec2-required-policy-config-rule'
Ec2RequiredPolicyConfigRule.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
##### `isOwnedResource`
```typescript
import { Ec2RequiredPolicyConfigRule } from 'ec2-required-policy-config-rule'
Ec2RequiredPolicyConfigRule.isOwnedResource(construct: IConstruct)
```
Returns true if the construct was created by CDK, and false otherwise.
###### `construct`Required
- *Type:* constructs.IConstruct
---
##### `isResource`
```typescript
import { Ec2RequiredPolicyConfigRule } from 'ec2-required-policy-config-rule'
Ec2RequiredPolicyConfigRule.isResource(construct: IConstruct)
```
Check whether the given construct is a Resource.
###### `construct`Required
- *Type:* constructs.IConstruct
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. |
| stack | aws-cdk-lib.Stack | The stack in which this resource is defined. |
| evaluationFunction | aws-cdk-lib.aws_lambda.IFunction | *No description.* |
| managedPolicy | aws-cdk-lib.aws_iam.IManagedPolicy | *No description.* |
| rule | aws-cdk-lib.aws_config.CustomRule | *No description.* |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `env`Required
```typescript
public readonly env: ResourceEnvironment;
```
- *Type:* aws-cdk-lib.ResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK
(generally, those created by creating new class instances like Role, Bucket, etc.),
this is always the same as the environment of the stack they belong to;
however, for imported resources
(those obtained from static methods like fromRoleArn, fromBucketName, etc.),
that might be different than the stack they were imported into.
---
##### `stack`Required
```typescript
public readonly stack: Stack;
```
- *Type:* aws-cdk-lib.Stack
The stack in which this resource is defined.
---
##### `evaluationFunction`Required
```typescript
public readonly evaluationFunction: IFunction;
```
- *Type:* aws-cdk-lib.aws_lambda.IFunction
---
##### `managedPolicy`Required
```typescript
public readonly managedPolicy: IManagedPolicy;
```
- *Type:* aws-cdk-lib.aws_iam.IManagedPolicy
---
##### `rule`Required
```typescript
public readonly rule: CustomRule;
```
- *Type:* aws-cdk-lib.aws_config.CustomRule
---
#### Constants
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| DEFAULT_EC2_ROLE_DESCRIPTION | string | *No description.* |
| DEFAULT_RULE_DESCRIPTION | string | *No description.* |
---
##### `DEFAULT_EC2_ROLE_DESCRIPTION`Required
```typescript
public readonly DEFAULT_EC2_ROLE_DESCRIPTION: string;
```
- *Type:* string
---
##### `DEFAULT_RULE_DESCRIPTION`Required
```typescript
public readonly DEFAULT_RULE_DESCRIPTION: string;
```
- *Type:* string
---
## Structs
### Ec2RequiredPolicyConfigRuleProps
#### Initializer
```typescript
import { Ec2RequiredPolicyConfigRuleProps } from 'ec2-required-policy-config-rule'
const ec2RequiredPolicyConfigRuleProps: Ec2RequiredPolicyConfigRuleProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| account | string | The AWS account ID this resource belongs to. |
| environmentFromArn | string | ARN to deduce region and account from. |
| physicalName | string | The value passed in by users to the physical name prop of the resource. |
| region | string | The AWS region this resource belongs to. |
| managedPolicy | aws-cdk-lib.aws_iam.IManagedPolicy | *No description.* |
| remediation | Ec2RequiredPolicyRemediationOptions | *No description.* |
---
##### `account`Optional
```typescript
public readonly account: string;
```
- *Type:* string
- *Default:* the resource is in the same account as the stack it belongs to
The AWS account ID this resource belongs to.
---
##### `environmentFromArn`Optional
```typescript
public readonly environmentFromArn: string;
```
- *Type:* string
- *Default:* take environment from `account`, `region` parameters, or use Stack environment.
ARN to deduce region and account from.
The ARN is parsed and the account and region are taken from the ARN.
This should be used for imported resources.
Cannot be supplied together with either `account` or `region`.
---
##### `physicalName`Optional
```typescript
public readonly physicalName: string;
```
- *Type:* string
- *Default:* The physical name will be allocated by CloudFormation at deployment time
The value passed in by users to the physical name prop of the resource.
`undefined` implies that a physical name will be allocated by
CloudFormation during deployment.
- a concrete value implies a specific physical name
- `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated
by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
---
##### `region`Optional
```typescript
public readonly region: string;
```
- *Type:* string
- *Default:* the resource is in the same region as the stack it belongs to
The AWS region this resource belongs to.
---
##### `managedPolicy`Required
```typescript
public readonly managedPolicy: IManagedPolicy;
```
- *Type:* aws-cdk-lib.aws_iam.IManagedPolicy
---
##### `remediation`Optional
```typescript
public readonly remediation: Ec2RequiredPolicyRemediationOptions;
```
- *Type:* Ec2RequiredPolicyRemediationOptions
---
### Ec2RequiredPolicyRemediationOptions
#### Initializer
```typescript
import { Ec2RequiredPolicyRemediationOptions } from 'ec2-required-policy-config-rule'
const ec2RequiredPolicyRemediationOptions: Ec2RequiredPolicyRemediationOptions = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| automatic | boolean | *No description.* |
| enabled | boolean | *No description.* |
| maxAutomaticAttempts | number | *No description.* |
| retryPeriod | aws-cdk-lib.Duration | *No description.* |
---
##### `automatic`Optional
```typescript
public readonly automatic: boolean;
```
- *Type:* boolean
---
##### `enabled`Optional
```typescript
public readonly enabled: boolean;
```
- *Type:* boolean
---
##### `maxAutomaticAttempts`Optional
```typescript
public readonly maxAutomaticAttempts: number;
```
- *Type:* number
---
##### `retryPeriod`Optional
```typescript
public readonly retryPeriod: Duration;
```
- *Type:* aws-cdk-lib.Duration
---