awschatbot

Documentation

Index

• func CfnSlackChannelConfiguration_CFN_RESOURCE_TYPE_NAME() *string
• func CfnSlackChannelConfiguration_IsCfnElement(x interface{}) *bool
• func CfnSlackChannelConfiguration_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnSlackChannelConfiguration_IsConstruct(x interface{}) *bool
• func NewCfnSlackChannelConfiguration_Override(c CfnSlackChannelConfiguration, scope constructs.Construct, id *string, ...)
• func NewSlackChannelConfiguration_Override(s SlackChannelConfiguration, scope constructs.Construct, id *string, ...)
• func SlackChannelConfiguration_IsConstruct(x interface{}) *bool
• func SlackChannelConfiguration_IsResource(construct constructs.IConstruct) *bool
• func SlackChannelConfiguration_MetricAll(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
• type CfnSlackChannelConfiguration
  • func NewCfnSlackChannelConfiguration(scope constructs.Construct, id *string, ...) CfnSlackChannelConfiguration
• type CfnSlackChannelConfigurationProps
• type ISlackChannelConfiguration
  • func SlackChannelConfiguration_FromSlackChannelConfigurationArn(scope constructs.Construct, id *string, slackChannelConfigurationArn *string) ISlackChannelConfiguration
• type LoggingLevel
• type SlackChannelConfiguration
  • func NewSlackChannelConfiguration(scope constructs.Construct, id *string, props *SlackChannelConfigurationProps) SlackChannelConfiguration
• type SlackChannelConfigurationProps

Functions

func CfnSlackChannelConfiguration_CFN_RESOURCE_TYPE_NAME

func CfnSlackChannelConfiguration_CFN_RESOURCE_TYPE_NAME() *string

func CfnSlackChannelConfiguration_IsCfnElement

func CfnSlackChannelConfiguration_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnSlackChannelConfiguration_IsCfnResource

func CfnSlackChannelConfiguration_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnSlackChannelConfiguration_IsConstruct

func CfnSlackChannelConfiguration_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnSlackChannelConfiguration_Override

func NewCfnSlackChannelConfiguration_Override(c CfnSlackChannelConfiguration, scope constructs.Construct, id *string, props *CfnSlackChannelConfigurationProps)

Create a new `AWS::Chatbot::SlackChannelConfiguration`.

func NewSlackChannelConfiguration_Override

func NewSlackChannelConfiguration_Override(s SlackChannelConfiguration, scope constructs.Construct, id *string, props *SlackChannelConfigurationProps)

Experimental.

func SlackChannelConfiguration_IsConstruct

func SlackChannelConfiguration_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func SlackChannelConfiguration_IsResource

func SlackChannelConfiguration_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func SlackChannelConfiguration_MetricAll

func SlackChannelConfiguration_MetricAll(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric

Return the given named metric for All SlackChannelConfigurations. Experimental.

Types

type CfnSlackChannelConfiguration

type CfnSlackChannelConfiguration interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ConfigurationName() *string
	SetConfigurationName(val *string)
	CreationStack() *[]*string
	GuardrailPolicies() *[]*string
	SetGuardrailPolicies(val *[]*string)
	IamRoleArn() *string
	SetIamRoleArn(val *string)
	LoggingLevel() *string
	SetLoggingLevel(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	SlackChannelId() *string
	SetSlackChannelId(val *string)
	SlackWorkspaceId() *string
	SetSlackWorkspaceId(val *string)
	SnsTopicArns() *[]*string
	SetSnsTopicArns(val *[]*string)
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	UserRoleRequired() interface{}
	SetUserRoleRequired(val interface{})
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Chatbot::SlackChannelConfiguration`.

TODO: EXAMPLE

func NewCfnSlackChannelConfiguration

func NewCfnSlackChannelConfiguration(scope constructs.Construct, id *string, props *CfnSlackChannelConfigurationProps) CfnSlackChannelConfiguration

Create a new `AWS::Chatbot::SlackChannelConfiguration`.

type CfnSlackChannelConfigurationProps

type CfnSlackChannelConfigurationProps struct {
	// `AWS::Chatbot::SlackChannelConfiguration.ConfigurationName`.
	ConfigurationName *string `json:"configurationName"`
	// `AWS::Chatbot::SlackChannelConfiguration.GuardrailPolicies`.
	GuardrailPolicies *[]*string `json:"guardrailPolicies"`
	// `AWS::Chatbot::SlackChannelConfiguration.IamRoleArn`.
	IamRoleArn *string `json:"iamRoleArn"`
	// `AWS::Chatbot::SlackChannelConfiguration.LoggingLevel`.
	LoggingLevel *string `json:"loggingLevel"`
	// `AWS::Chatbot::SlackChannelConfiguration.SlackChannelId`.
	SlackChannelId *string `json:"slackChannelId"`
	// `AWS::Chatbot::SlackChannelConfiguration.SlackWorkspaceId`.
	SlackWorkspaceId *string `json:"slackWorkspaceId"`
	// `AWS::Chatbot::SlackChannelConfiguration.SnsTopicArns`.
	SnsTopicArns *[]*string `json:"snsTopicArns"`
	// `AWS::Chatbot::SlackChannelConfiguration.UserRoleRequired`.
	UserRoleRequired interface{} `json:"userRoleRequired"`
}

Properties for defining a `AWS::Chatbot::SlackChannelConfiguration`.

TODO: EXAMPLE

type ISlackChannelConfiguration

type ISlackChannelConfiguration interface {
	awsiam.IGrantable
	awscodestarnotifications.INotificationRuleTarget
	awscdk.IResource
	// Adds a statement to the IAM role.
	// Experimental.
	AddToRolePolicy(statement awsiam.PolicyStatement)
	// Return the given named metric for this SlackChannelConfiguration.
	// Experimental.
	Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// The permission role of Slack channel configuration.
	// Experimental.
	Role() awsiam.IRole
	// The ARN of the Slack channel configuration In the form of arn:aws:chatbot:{region}:{account}:chat-configuration/slack-channel/{slackChannelName}.
	// Experimental.
	SlackChannelConfigurationArn() *string
	// The name of Slack channel configuration.
	// Experimental.
	SlackChannelConfigurationName() *string
}

Represents a Slack channel configuration. Experimental.

func SlackChannelConfiguration_FromSlackChannelConfigurationArn

func SlackChannelConfiguration_FromSlackChannelConfigurationArn(scope constructs.Construct, id *string, slackChannelConfigurationArn *string) ISlackChannelConfiguration

Import an existing Slack channel configuration provided an ARN.

Returns: a reference to the existing Slack channel configuration Experimental.

type LoggingLevel

type LoggingLevel string

Logging levels include ERROR, INFO, or NONE. Experimental.

const (
	LoggingLevel_ERROR LoggingLevel = "ERROR"
	LoggingLevel_INFO  LoggingLevel = "INFO"
	LoggingLevel_NONE  LoggingLevel = "NONE"
)

type SlackChannelConfiguration

type SlackChannelConfiguration interface {
	awscdk.Resource
	ISlackChannelConfiguration
	Env() *awscdk.ResourceEnvironment
	GrantPrincipal() awsiam.IPrincipal
	Node() constructs.Node
	PhysicalName() *string
	Role() awsiam.IRole
	SlackChannelConfigurationArn() *string
	SlackChannelConfigurationName() *string
	Stack() awscdk.Stack
	AddNotificationTopic(notificationTopic awssns.ITopic)
	AddToRolePolicy(statement awsiam.PolicyStatement)
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	BindAsNotificationRuleTarget(_scope constructs.Construct) *awscodestarnotifications.NotificationRuleTargetConfig
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	ToString() *string
}

A new Slack channel configuration.

TODO: EXAMPLE

Experimental.

func NewSlackChannelConfiguration

func NewSlackChannelConfiguration(scope constructs.Construct, id *string, props *SlackChannelConfigurationProps) SlackChannelConfiguration

Experimental.

type SlackChannelConfigurationProps

type SlackChannelConfigurationProps struct {
	// The name of Slack channel configuration.
	// Experimental.
	SlackChannelConfigurationName *string `json:"slackChannelConfigurationName"`
	// The ID of the Slack channel.
	//
	// To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link.
	// The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.
	// Experimental.
	SlackChannelId *string `json:"slackChannelId"`
	// The ID of the Slack workspace authorized with AWS Chatbot.
	//
	// To get the workspace ID, you must perform the initial authorization flow with Slack in the AWS Chatbot console.
	// Then you can copy and paste the workspace ID from the console.
	// For more details, see steps 1-4 in Setting Up AWS Chatbot with Slack in the AWS Chatbot User Guide.
	// See: https://docs.aws.amazon.com/chatbot/latest/adminguide/setting-up.html#Setup_intro
	//
	// Experimental.
	SlackWorkspaceId *string `json:"slackWorkspaceId"`
	// Specifies the logging level for this configuration.
	//
	// This property affects the log entries pushed to Amazon CloudWatch Logs.
	// Experimental.
	LoggingLevel LoggingLevel `json:"loggingLevel"`
	// The number of days log events are kept in CloudWatch Logs.
	//
	// When updating
	// this property, unsetting it doesn't remove the log retention policy. To
	// remove the retention policy, set the value to `INFINITE`.
	// Experimental.
	LogRetention awslogs.RetentionDays `json:"logRetention"`
	// When log retention is specified, a custom resource attempts to create the CloudWatch log group.
	//
	// These options control the retry policy when interacting with CloudWatch APIs.
	// Experimental.
	LogRetentionRetryOptions *awslogs.LogRetentionRetryOptions `json:"logRetentionRetryOptions"`
	// The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
	// Experimental.
	LogRetentionRole awsiam.IRole `json:"logRetentionRole"`
	// The SNS topics that deliver notifications to AWS Chatbot.
	// Experimental.
	NotificationTopics *[]awssns.ITopic `json:"notificationTopics"`
	// The permission role of Slack channel configuration.
	// Experimental.
	Role awsiam.IRole `json:"role"`
}

Properties for a new Slack channel configuration.

TODO: EXAMPLE

Experimental.