Skip to content

Latest commit

 

History

History
297 lines (181 loc) · 10.6 KB

API.md

File metadata and controls

297 lines (181 loc) · 10.6 KB
Raw

API Reference

Constructs

FsxLifecycleStatusMonitor

Initializers 

import { FsxLifecycleStatusMonitor } from 'aws-fsx-lifecycle-status-monitor'

new FsxLifecycleStatusMonitor(scope: Construct, id: string, props: FsxLifecycleStatusMonitorProps)
Name Type Description
scope constructs.Construct - parent construct.
id string - unique id.
props FsxLifecycleStatusMonitorProps No description.
scopeRequired
  • Type: constructs.Construct

parent construct.

idRequired
  • Type: string

unique id.

propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
createIamPolicy No description.
createLambdaFunction No description.
createSNSTopic Topic linked to the Lambda function.
toString 
public toString(): string

Returns a string representation of this construct.

createIamPolicy 
public createIamPolicy(): Policy
createLambdaFunction 
public createLambdaFunction(): Function
createSNSTopic 
public createSNSTopic(): Topic

Topic linked to the Lambda function.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { FsxLifecycleStatusMonitor } from 'aws-fsx-lifecycle-status-monitor'

FsxLifecycleStatusMonitor.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
fn aws-cdk-lib.aws_lambda.Function The Lambda function that will be triggered by the CloudWatch event.
logGroup aws-cdk-lib.aws_logs.LogGroup Log group for the Lambda function.
policy aws-cdk-lib.aws_iam.Policy The IAM policy that will be attached to the Lambda function.
rule aws-cdk-lib.aws_events.Rule The CloudWatch event rule that will trigger the Lambda function.
topic aws-cdk-lib.aws_sns.Topic Topic linked to the Lambda function.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

fnRequired 
public readonly fn: Function;
  • Type: aws-cdk-lib.aws_lambda.Function

The Lambda function that will be triggered by the CloudWatch event.

logGroupRequired 
public readonly logGroup: LogGroup;
  • Type: aws-cdk-lib.aws_logs.LogGroup

Log group for the Lambda function.

policyRequired 
public readonly policy: Policy;
  • Type: aws-cdk-lib.aws_iam.Policy

The IAM policy that will be attached to the Lambda function.

ruleRequired 
public readonly rule: Rule;
  • Type: aws-cdk-lib.aws_events.Rule

The CloudWatch event rule that will trigger the Lambda function.

topicRequired 
public readonly topic: Topic;
  • Type: aws-cdk-lib.aws_sns.Topic

Topic linked to the Lambda function.

Constants

Name Type Description
DEFAULT_LOG_RETENTION_PERIOD aws-cdk-lib.aws_logs.RetentionDays Default log retention for the FSx Lifecycle Status Monitor.
DEFAULT_SCHEDULE aws-cdk-lib.aws_events.Schedule Default schedule for the FSx Lifecycle Status Monitor.
DEFAULT_LOG_RETENTION_PERIODRequired 
public readonly DEFAULT_LOG_RETENTION_PERIOD: RetentionDays;
  • Type: aws-cdk-lib.aws_logs.RetentionDays

Default log retention for the FSx Lifecycle Status Monitor.

DEFAULT_SCHEDULERequired 
public readonly DEFAULT_SCHEDULE: Schedule;
  • Type: aws-cdk-lib.aws_events.Schedule

Default schedule for the FSx Lifecycle Status Monitor.

Structs

FsxLifecycleStatusMonitorProps

Configuration properties for the FSx Lifecycle Status Monitor.

Initializer 

import { FsxLifecycleStatusMonitorProps } from 'aws-fsx-lifecycle-status-monitor'

const fsxLifecycleStatusMonitorProps: FsxLifecycleStatusMonitorProps = { ... }

Properties

Name Type Description
logRetentionDays aws-cdk-lib.aws_logs.RetentionDays The log retention days for the FSx Lifecycle Status Monitor.
schedule aws-cdk-lib.aws_events.Schedule The schedule for the FSx Lifecycle Status Monitor.
logRetentionDaysOptional 
public readonly logRetentionDays: RetentionDays;
  • Type: aws-cdk-lib.aws_logs.RetentionDays
  • Default: logs.RetentionDays.ONE_YEAR

The log retention days for the FSx Lifecycle Status Monitor.

Example

this.monitor = new FsxLifecycleStatusMonitor(this, "monitor",{
  logRetentionDays: logs.RetentionDays.ONE_MONTH
});
scheduleOptional 
public readonly schedule: Schedule;
  • Type: aws-cdk-lib.aws_events.Schedule
  • Default: "events.Schedule.cron({ minute: '0/10', hour: '', day: '', month: '', year: '' })"

The schedule for the FSx Lifecycle Status Monitor.

Example

this.monitor = new FsxLifecycleStatusMonitor(this, "monitor",{
  logRetentionDays: logs.RetentionDays.ONE_MONTH,
  schedule: events.Schedule.rate(cdk.Duration.hours(1)),
});