Skip to content

Latest commit

 

History

History
207 lines (123 loc) · 8.56 KB

API.md

File metadata and controls

207 lines (123 loc) · 8.56 KB

API Reference

Constructs

SNSSlackMessageLambdaSubscription

Initializers 

import { SNSSlackMessageLambdaSubscription } from '@gammarers/aws-sns-slack-message-lambda-subscription'

new SNSSlackMessageLambdaSubscription(scope: Construct, id: string, props: SNSSlackMessageLambdaSubscriptionProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props SNSSlackMessageLambdaSubscriptionProps 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 { SNSSlackMessageLambdaSubscription } from '@gammarers/aws-sns-slack-message-lambda-subscription'

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

ResourceCustomNaming

Initializer 

import { ResourceCustomNaming } from '@gammarers/aws-sns-slack-message-lambda-subscription'

const resourceCustomNaming: ResourceCustomNaming = { ... }

Properties

Name Type Description
functionName string No description.
functionRoleName string No description.
type @gammarers/aws-resource-naming.ResourceNamingType No description.
functionNameRequired 
public readonly functionName: string;
  • Type: string
functionRoleNameRequired 
public readonly functionRoleName: string;
  • Type: string
typeRequired 
public readonly type: ResourceNamingType;
  • Type: @gammarers/aws-resource-naming.ResourceNamingType

SNSSlackMessageLambdaSubscriptionProps

Initializer 

import { SNSSlackMessageLambdaSubscriptionProps } from '@gammarers/aws-sns-slack-message-lambda-subscription'

const sNSSlackMessageLambdaSubscriptionProps: SNSSlackMessageLambdaSubscriptionProps = { ... }

Properties

Name Type Description
slackWebhookSecretName string No description.
topic aws-cdk-lib.aws_sns.ITopic No description.
resourceNamingOption ResourceCustomNaming | @gammarers/aws-resource-naming.ResourceDefaultNaming No description.
slackWebhookSecretNameRequired 
public readonly slackWebhookSecretName: string;
  • Type: string
topicRequired 
public readonly topic: ITopic;
  • Type: aws-cdk-lib.aws_sns.ITopic
resourceNamingOptionOptional 
public readonly resourceNamingOption: ResourceCustomNaming | ResourceDefaultNaming;