Chatbot

3 resource kinds. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

ChatbotCustomAction # CLOUD CONTROL · AWS::Chatbot::CustomAction

ChatbotCustomAction manages AWS::Chatbot::CustomAction through the AWS Cloud Control API.

kubectl get chatbotcustomactions · example on GitHub

Example

# ChatbotCustomAction — Chatbot
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/chatbot.html#chatbotcustomaction
apiVersion: aws.konfig.io/v1alpha1
kind: ChatbotCustomAction
metadata:
  name: example-chatbotcustomaction
  namespace: default
spec:
  actionName: example-chatbotcustomaction
  aliasName: example-chatbotcustomaction
  attachments:
  - buttonText: example
    criteria:
    - operator: HAS_VALUE
      value: example
      variableName: example-chatbotcustomaction
    notificationType: example
    variables:
      key: value
  definition:
    commandText: example
  providerRef:
    name: example-chatbotcustomaction
    region: us-east-1
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`actionName`	string	yes	Create-only in AWS: changing it requires replacing the resource.
`aliasName`	string	—
`attachments`	array<object>	—
`attachments[].buttonText`	string	—
`attachments[].criteria`	array<object>	—
`attachments[].criteria[].operator`	enum	yes	Allowed: `HAS_VALUE, EQUALS`
`attachments[].criteria[].value`	string	—
`attachments[].criteria[].variableName`	string	yes
`attachments[].notificationType`	string	—
`attachments[].variables`	map<string>	—
`definition`	object	yes	ChatbotCustomActionCustomActionDefinition is a nested property type of AWS::Chatbot::CustomAction.
`definition.commandText`	string	yes
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`tags`	array<object>	—
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`customActionArn`	string	—	Read-only: reported by AWS after creation.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

ChatbotMicrosoftTeamsChannelConfiguration # CLOUD CONTROL · AWS::Chatbot::MicrosoftTeamsChannelConfiguration

ChatbotMicrosoftTeamsChannelConfiguration manages AWS::Chatbot::MicrosoftTeamsChannelConfiguration through the AWS Cloud Control API.

kubectl get chatbotmicrosoftteamschannelconfigurations · example on GitHub

Example

# ChatbotMicrosoftTeamsChannelConfiguration — Chatbot
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/chatbot.html#chatbotmicrosoftteamschannelconfiguration
apiVersion: aws.konfig.io/v1alpha1
kind: ChatbotMicrosoftTeamsChannelConfiguration
metadata:
  name: example-chatbotmicrosoftteamschannelconfiguration
  namespace: default
spec:
  configurationName: example-chatbotmicrosoftteamschannelconfiguration
  customizationResourceArns:
  - example
  guardrailPolicies:
  - example
  iamRoleArn: arn:aws:iam::123456789012:role/example-role
  loggingLevel: example
  providerRef:
    name: example-chatbotmicrosoftteamschannelconfiguration
    region: us-east-1
  snsTopicArns:
  - example
  tags:
  - key: example
    value: example
  teamId: example-id-xxxxxxxxxxxxxxxxxxxxxxxxx
  teamsChannelId: example-id
  teamsChannelName: example-chatbotmicrosoftteamschannelconfiguration
  teamsTenantId: example-id-xxxxxxxxxxxxxxxxxxxxxxxxx
  userRoleRequired: false

Spec

Field	Type	Required	Description
`configurationName`	string	yes	The name of the configuration Create-only in AWS: changing it requires replacing the resource.
`customizationResourceArns`	array<string>	—	ARNs of Custom Actions to associate with notifications in the provided chat channel.
`guardrailPolicies`	array<string>	—	The list of IAM policy ARNs that are applied as channel guardrails.
`iamRoleArn`	string	yes	The ARN of the IAM role that defines the permissions for AWS Chatbot
`loggingLevel`	string	—	Specifies the logging level for this configuration:ERROR,INFO or NONE.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`snsTopicArns`	array<string>	—	ARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications.
`tags`	array<object>	—	The tags to add to the configuration
`tags[].key`	string	yes
`tags[].value`	string	yes
`teamId`	string	yes	The id of the Microsoft Teams team Create-only in AWS: changing it requires replacing the resource.
`teamsChannelId`	string	yes	The id of the Microsoft Teams channel
`teamsChannelName`	string	—	The name of the Microsoft Teams channel
`teamsTenantId`	string	yes	The id of the Microsoft Teams tenant Create-only in AWS: changing it requires replacing the resource.
`userRoleRequired`	boolean	—	Enables use of a user role requirement in your chat configuration

Status

Field	Type	Required	Description
`arn`	string	—	Amazon Resource Name (ARN) of the configuration Read-only: reported by AWS after creation.
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

ChatbotSlackChannelConfiguration # CLOUD CONTROL · AWS::Chatbot::SlackChannelConfiguration

ChatbotSlackChannelConfiguration manages AWS::Chatbot::SlackChannelConfiguration through the AWS Cloud Control API.

kubectl get chatbotslackchannelconfigurations · example on GitHub

Example

# ChatbotSlackChannelConfiguration — Chatbot
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/chatbot.html#chatbotslackchannelconfiguration
apiVersion: aws.konfig.io/v1alpha1
kind: ChatbotSlackChannelConfiguration
metadata:
  name: example-chatbotslackchannelconfiguration
  namespace: default
spec:
  configurationName: example-chatbotslackchannelconfiguration
  customizationResourceArns:
  - example
  guardrailPolicies:
  - example
  iamRoleArn: arn:aws:iam::123456789012:role/example-role
  loggingLevel: example
  providerRef:
    name: example-chatbotslackchannelconfiguration
    region: us-east-1
  slackChannelId: example-id
  slackWorkspaceId: example-id
  snsTopicArns:
  - example
  tags:
  - key: example
    value: example
  userRoleRequired: false

Spec

Field	Type	Required	Description
`configurationName`	string	yes	The name of the configuration Create-only in AWS: changing it requires replacing the resource.
`customizationResourceArns`	array<string>	—	ARNs of Custom Actions to associate with notifications in the provided chat channel.
`guardrailPolicies`	array<string>	—	The list of IAM policy ARNs that are applied as channel guardrails.
`iamRoleArn`	string	yes	The ARN of the IAM role that defines the permissions for AWS Chatbot
`loggingLevel`	string	—	Specifies the logging level for this configuration:ERROR,INFO or NONE.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`slackChannelId`	string	yes	The id of the Slack channel
`slackWorkspaceId`	string	yes	The id of the Slack workspace Create-only in AWS: changing it requires replacing the resource.
`snsTopicArns`	array<string>	—	ARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications.
`tags`	array<object>	—	The tags to add to the configuration
`tags[].key`	string	yes
`tags[].value`	string	yes
`userRoleRequired`	boolean	—	Enables use of a user role requirement in your chat configuration

Status

Field	Type	Required	Description
`arn`	string	—	Amazon Resource Name (ARN) of the configuration Read-only: reported by AWS after creation.
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.