https://kubevela.io/assets/js/af37986b.eae9855b.js

1"use strict";(self.webpackChunkkubevela_io=self.webpackChunkkubevela_io||[]).push([[1127],{28453:(e,t,s)=>{s.d(t,{R:()=>i,x:()=>c});var d=s(96540);const r={},n=d.createContext(r);function i(e){const t=d.useContext(n);return d.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),d.createElement(n.Provider,{value:t},e.children)}},77573:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>l,contentTitle:()=>c,default:()=>a,frontMatter:()=>i,metadata:()=>d,toc:()=>o});const d=JSON.parse('{"id":"end-user/components/cloud-services/terraform/aws-notify-slack","title":"AWS NOTIFY-SLACK","description":"Description","source":"@site/versioned_docs/version-v1.7/end-user/components/cloud-services/terraform/aws-notify-slack.md","sourceDirName":"end-user/components/cloud-services/terraform","slug":"/end-user/components/cloud-services/terraform/aws-notify-slack","permalink":"/docs/v1.7/end-user/components/cloud-services/terraform/aws-notify-slack","draft":false,"unlisted":false,"editUrl":"https://github.com/kubevela/kubevela.io/edit/main/docs/end-user/components/cloud-services/terraform/aws-notify-slack.md","tags":[],"version":"v1.7","lastUpdatedBy":"barnettZQG","lastUpdatedAt":1673625569000,"frontMatter":{"title":"AWS NOTIFY-SLACK"}}');var r=s(74848),n=s(28453);const i={title:"AWS NOTIFY-SLACK"},c=void 0,l={},o=[{value:"Description",id:"description",level:2},{value:"Specification",id:"specification",level:2},{value:"Properties",id:"properties",level:3},{value:"writeConnectionSecretToRef",id:"writeconnectionsecrettoref",level:4}];function h(e){const t={a:"a",h2:"h2",h3:"h3",h4:"h4",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h2,{id:"description",children:"Description"}),"\n",(0,r.jsx)(t.p,{children:"Terraform module which creates SNS topic and Lambda function which sends notifications to Slack"}),"\n",(0,r.jsx)(t.h2,{id:"specification",children:"Specification"}),"\n",(0,r.jsx)(t.h3,{id:"properties",children:"Properties"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Name"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Type"}),(0,r.jsx)(t.th,{children:"Required"}),(0,r.jsx)(t.th,{children:"Default"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"cloudwatch_log_group_kms_key_id"}),(0,r.jsx)(t.td,{children:"The ARN of the KMS Key to use when encrypting log data for Lambda"}),(0,r.jsx)(t.td,{children:"string"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"cloudwatch_log_group_retention_in_days"}),(0,r.jsx)(t.td,{children:"Specifies the number of days you want to retain log events in log group for Lambda."}),(0,r.jsx)(t.td,{children:"number"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"cloudwatch_log_group_tags"}),(0,r.jsx)(t.td,{children:"Additional tags for the Cloudwatch log group"}),(0,r.jsx)(t.td,{children:"map(string)"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"create"}),(0,r.jsx)(t.td,{children:"Whether to create all resources"}),(0,r.jsx)(t.td,{children:"bool"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"create_sns_topic"}),(0,r.jsx)(t.td,{children:"Whether to create new SNS topic"}),(0,r.jsx)(t.td,{children:"bool"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"iam_policy_path"}),(0,r.jsx)(t.td,{children:"Path of policies to that should be added to IAM role for Lambda Function"}),(0,r.jsx)(t.td,{children:"string"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"iam_role_boundary_policy_arn"}),(0,r.jsx)(t.td,{children:"The ARN of the policy that is used to set the permissions boun

1dary for the role"}),(0,r.jsx)(t.td,{children:"string"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"iam_role_name_prefix"}),(0,r.jsx)(t.td,{children:"A unique role name beginning with the specified prefix"}),(0,r.jsx)(t.td,{children:"string"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"iam_role_path"}),(0,r.jsx)(t.td,{children:"Path of IAM role to use for Lambda Function"}),(0,r.jsx)(t.td,{children:"string"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"iam_role_tags"}),(0,r.jsx)(t.td,{children:"Additional tags for the IAM role"}),(0,r.jsx)(t.td,{children:"map(string)"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"kms_key_arn"}),(0,r.jsx)(t.td,{children:"ARN of the KMS key used for decrypting slack webhook url"}),(0,r.jsx)(t.td,{children:"string"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"lambda_description"}),(0,r.jsx)(t.td,{children:"The description of the Lambda function"}),(0,r.jsx)(t.td,{children:"string"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"lambda_function_name"}),(0,r.jsx)(t.td,{children:"The name of the Lambda function to create"}),(0,r.jsx)(t.td,{children:"string"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"lambda_function_s3_bucket"}),(0,r.jsx)(t.td,{children:"S3 bucket to store artifacts"}),(0,r.jsx)(t.td,{children:"string"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"lambda_function_store_on_s3"}),(0,r.jsx)(t.td,{children:"Whether to store produced artifacts on S3 or locally."}),(0,r.jsx)(t.td,{children:"bool"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"lambda_function_tags"}),(0,r.jsx)(t.td,{children:"Additional tags for the Lambda function"}),(0,r.jsx)(t.td,{children:"map(string)"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"lambda_function_vpc_security_group_ids"}),(0,r.jsx)(t.td,{children:"List of security group ids when Lambda Function should run in the VPC."}),(0,r.jsx)(t.td,{children:"list(string)"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"lambda_function_vpc_subnet_ids"}),(0,r.jsx)(t.td,{children:"List of subnet ids when Lambda Function should run in the VPC. Usually private or intra subnets."}),(0,r.jsx)(t.td,{children:"list(string)"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"lambda_role"}),(0,r.jsx)(t.td,{children:"IAM role attached to the Lambda Function.  If this is set then a role will not be created for you."}),(0,r.jsx)(t.td,{children:"string"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"log_events"}),(0,r.jsx)(t.td,{children:"Boolean flag to enabled/disable logging of incoming events"}),(0,r.jsx)(t.td,{children:"bool"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"recreate_missing_package"}),(0,r.jsx)(t.td,{children:"Whether to recreate missing Lambda package if it is missing locally or not"}),(0,r.jsx)(t.td,{children:"bool"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"reserved_concurrent_executions"}),(0,r.jsx)(t.td,{children:"The amount of reserved concurrent executions for this lambda function. A value of 0 disables lambda from being triggered and -1 removes any concurrency limitations"}),(0,r.jsx)(t.td,{children:"number"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"slack_channel"}),(0,r.jsx)(t.td,{children:"The name of the channel in Slack for notifications"}),(0,r.jsx)(t.td,{children:"string"}),(0,r.jsx)(t.td,{children:"true"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"slack_emoji"}),(0,r.jsx)(t.td,{children:"A custom emoji that will appear on Slack messages"}),(0,r.jsx)(t.td,{children:"string"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"slack_username"}),(0,r.jsx)(t.td,{children:"The username that will appear on Slack messages"}),(0,r.jsx)(t.td,{children:"string"}),(0,r.jsx)(t.td,{children:"true"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"slack_webhook_url"}),(0,r.jsx)(t.td,{children:"The URL of Slack webhook"}),(0,r.jsx)(t.td,{children:"string"}),(0,r.jsx)(t.td,{children:"true"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"sns_topic_kms_key_id"}),(0,r.jsx)(t.td,{children:"ARN of the KMS key used for enabling SSE on the topic"}),(0,r.jsx)(t.td,{children:"string"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"sns_topic_name"}),(0,r.jsx)(t.td,{children:"The name of the SNS topic to create"}),(0,r.jsx)(t.td,{children:"string"}),(0,r.jsx)(t.td,{children:"true"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"sns_topic_tags"}),(0,r.jsx)(t.td,{children:"Additional tags for the SNS topic"}),(0,r.jsx)(t.td,{children:"map(string)"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"subscription_filter_policy"}

1),(0,r.jsx)(t.td,{children:"(Optional) A valid filter policy that will be used in the subscription to filter messages seen by the target resource."}),(0,r.jsx)(t.td,{children:"string"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"tags"}),(0,r.jsx)(t.td,{children:"A map of tags to add to all resources"}),(0,r.jsx)(t.td,{children:"map(string)"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"writeConnectionSecretToRef"}),(0,r.jsx)(t.td,{children:"The secret which the cloud resource connection will be written to"}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.a,{href:"#writeConnectionSecretToRef",children:"writeConnectionSecretToRef"})}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]})]})]}),"\n",(0,r.jsx)(t.h4,{id:"writeconnectionsecrettoref",children:"writeConnectionSecretToRef"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Name"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Type"}),(0,r.jsx)(t.th,{children:"Required"}),(0,r.jsx)(t.th,{children:"Default"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"name"}),(0,r.jsx)(t.td,{children:"The secret name which the cloud resource connection will be written to"}),(0,r.jsx)(t.td,{children:"string"}),(0,r.jsx)(t.td,{children:"true"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"namespace"}),(0,r.jsx)(t.td,{children:"The secret namespace which the cloud resource connection will be written to"}),(0,r.jsx)(t.td,{children:"string"}),(0,r.jsx)(t.td,{children:"false"}),(0,r.jsx)(t.td,{})]})]})]})]})}function a(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}}}]);