Skip to content

Latest commit

 

History

History
990 lines (593 loc) · 27 KB

API.md

File metadata and controls

990 lines (593 loc) · 27 KB

API Reference

Constructs

OrgAccountInit

Initializers

import { OrgAccountInit } from 'blea'

new OrgAccountInit(scope: Construct, id: string, props: OrgAccountInitProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props OrgAccountInitProps 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 { OrgAccountInit } from 'blea'

OrgAccountInit.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.


OrgConfigRules

Initializers

import { OrgConfigRules } from 'blea'

new OrgConfigRules(scope: Construct, id: string, props: OrgConfigRulesProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props OrgConfigRulesProps 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 { OrgConfigRules } from 'blea'

OrgConfigRules.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.


OrgConfigSecurityhub

Initializers

import { OrgConfigSecurityhub } from 'blea'

new OrgConfigSecurityhub(scope: Construct, id: string, props: Props)
Name Type Description
scope constructs.Construct No description.
id string No description.
props Props 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 { OrgConfigSecurityhub } from 'blea'

OrgConfigSecurityhub.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.


OrgEvent

Initializers

import { OrgEvent } from 'blea'

new OrgEvent(scope: Construct, id: string, props: EventSnsProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props EventSnsProps 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 { OrgEvent } from 'blea'

OrgEvent.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.


Properties

Name Type Description
node constructs.Node The tree node.
topic aws-cdk-lib.aws_sns.Topic No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


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

OrgRoleStackSet

Initializers

import { OrgRoleStackSet } from 'blea'

new OrgRoleStackSet(scope: Construct, id: string, props: OrgRoleStackSetProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props OrgRoleStackSetProps 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 { OrgRoleStackSet } from 'blea'

OrgRoleStackSet.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.


OrgSlack

Initializers

import { OrgSlack } from 'blea'

new OrgSlack(scope: Construct, id: string, props: OrgSlackProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props OrgSlackProps 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 { OrgSlack } from 'blea'

OrgSlack.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.


Structs

EventSnsProps

Initializer

import { EventSnsProps } from 'blea'

const eventSnsProps: EventSnsProps = { ... }

Properties

Name Type Description
accountId string No description.
kmsAliasName string No description.
region string No description.
securityhubNotifyPattern aws-cdk-lib.aws_events.EventPattern No description.

accountIdRequired
public readonly accountId: string;
  • Type: string

kmsAliasNameRequired
public readonly kmsAliasName: string;
  • Type: string

regionRequired
public readonly region: string;
  • Type: string

securityhubNotifyPatternRequired
public readonly securityhubNotifyPattern: EventPattern;
  • Type: aws-cdk-lib.aws_events.EventPattern

OrgAccountInitProps

Initializer

import { OrgAccountInitProps } from 'blea'

const orgAccountInitProps: OrgAccountInitProps = { ... }

Properties

Name Type Description
controlTowerHomeRegion string No description.
disableArnsBasicAll string[] No description.
disableArnsBasicVA string[] No description.
disableArnsCISAll string[] No description.
disableArnsCISNotCtHome string[] No description.
roleName string No description.

controlTowerHomeRegionRequired
public readonly controlTowerHomeRegion: string;
  • Type: string

disableArnsBasicAllRequired
public readonly disableArnsBasicAll: string[];
  • Type: string[]

disableArnsBasicVARequired
public readonly disableArnsBasicVA: string[];
  • Type: string[]

disableArnsCISAllRequired
public readonly disableArnsCISAll: string[];
  • Type: string[]

disableArnsCISNotCtHomeRequired
public readonly disableArnsCISNotCtHome: string[];
  • Type: string[]

roleNameRequired
public readonly roleName: string;
  • Type: string

OrgConfigRulesProps

Initializer

import { OrgConfigRulesProps } from 'blea'

const orgConfigRulesProps: OrgConfigRulesProps = { ... }

Properties

Name Type Description
configRulesAll any[] No description.
region string No description.
configExcludedAccounts string[] No description.
configRulesOnlyUsEast1 any[] No description.

configRulesAllRequired
public readonly configRulesAll: any[];
  • Type: any[]

regionRequired
public readonly region: string;
  • Type: string

configExcludedAccountsOptional
public readonly configExcludedAccounts: string[];
  • Type: string[]

configRulesOnlyUsEast1Optional
public readonly configRulesOnlyUsEast1: any[];
  • Type: any[]

OrgRoleStackSetProps

Initializer

import { OrgRoleStackSetProps } from 'blea'

const orgRoleStackSetProps: OrgRoleStackSetProps = { ... }

Properties

Name Type Description
auditAccountID string No description.
roleName string No description.
stackInstancesGroup aws-cdk-lib.aws_cloudformation.CfnStackSet.StackInstancesProperty No description.

auditAccountIDRequired
public readonly auditAccountID: string;
  • Type: string

roleNameRequired
public readonly roleName: string;
  • Type: string

stackInstancesGroupRequired
public readonly stackInstancesGroup: StackInstancesProperty;
  • Type: aws-cdk-lib.aws_cloudformation.CfnStackSet.StackInstancesProperty

OrgSlackProps

Initializer

import { OrgSlackProps } from 'blea'

const orgSlackProps: OrgSlackProps = { ... }

Properties

Name Type Description
channelId string No description.
slackChannelConfigurationName string No description.
snsTopic aws-cdk-lib.aws_sns.Topic[] No description.
workspaceId string No description.

channelIdRequired
public readonly channelId: string;
  • Type: string

slackChannelConfigurationNameRequired
public readonly slackChannelConfigurationName: string;
  • Type: string

snsTopicRequired
public readonly snsTopic: Topic[];
  • Type: aws-cdk-lib.aws_sns.Topic[]

workspaceIdRequired
public readonly workspaceId: string;
  • Type: string

Props

Initializer

import { Props } from 'blea'

const props: Props = { ... }

Properties

Name Type Description
auditAccountId string No description.
configurationAggregatorName string No description.
controlTowerHomeRegion string No description.
snsTopicArn string No description.

auditAccountIdRequired
public readonly auditAccountId: string;
  • Type: string

configurationAggregatorNameRequired
public readonly configurationAggregatorName: string;
  • Type: string

controlTowerHomeRegionRequired
public readonly controlTowerHomeRegion: string;
  • Type: string

snsTopicArnRequired
public readonly snsTopicArn: string;
  • Type: string