AWS::QuickSight::ActionConnector - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::QuickSight::ActionConnector

Creates an action connector that enables Amazon Quick Sight to connect to external services and perform actions. Action connectors support various authentication methods and can be configured with specific actions from supported connector types like Amazon S3, Salesforce, JIRA.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::QuickSight::ActionConnector",
  "Properties" : {
      "ActionConnectorId" : String,
      "AuthenticationConfig" : AuthConfig,
      "AwsAccountId" : String,
      "Description" : String,
      "Name" : String,
      "Permissions" : [ ResourcePermission, ... ],
      "Tags" : [ Tag, ... ],
      "Type" : String,
      "VpcConnectionArn" : String
    }
}

YAML

Type: AWS::QuickSight::ActionConnector
Properties:
  ActionConnectorId: String
  AuthenticationConfig: 
    AuthConfig
  AwsAccountId: String
  Description: String
  Name: String
  Permissions: 
    - ResourcePermission
  Tags: 
    - Tag
  Type: String
  VpcConnectionArn: String

Properties

ActionConnectorId

The unique identifier of the action connector.

Required: Yes

Type: String

Pattern: ^[\w\-]+$

Minimum: 1

Maximum: 512

Update requires: Replacement

AuthenticationConfig

The authentication configuration used to connect to the external service.

Required: No

Type: AuthConfig

Update requires: No interruption

AwsAccountId

The AWS account ID associated with the action connector.

Required: Yes

Type: String

Pattern: ^[0-9]{12}$

Minimum: 12

Maximum: 12

Update requires: Replacement

Description

The description of the action connector.

Required: No

Type: String

Pattern: ^[A-Za-z0-9 _.,!?-]*$

Minimum: 1

Maximum: 2048

Update requires: No interruption

Name

The name of the action connector.

Required: Yes

Type: String

Pattern: ^[A-Za-z0-9](?:[\w- ]*[A-Za-z0-9])?$

Minimum: 1

Maximum: 255

Update requires: No interruption

Permissions

The permissions configuration that defines which users, groups, or namespaces can access this action connector and what operations they can perform.

Required: No

Type: Array of ResourcePermission

Minimum: 1

Maximum: 64

Update requires: No interruption

Tags

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: Array of Tag

Minimum: 1

Maximum: 200

Update requires: No interruption

Type

The type of action connector.

Required: Yes

Type: String

Allowed values: GENERIC_HTTP | SERVICENOW_NOW_PLATFORM | SALESFORCE_CRM | MICROSOFT_OUTLOOK | PAGERDUTY_ADVANCE | JIRA_CLOUD | ATLASSIAN_CONFLUENCE | AMAZON_S3 | AMAZON_BEDROCK_AGENT_RUNTIME | AMAZON_BEDROCK_RUNTIME | AMAZON_BEDROCK_DATA_AUTOMATION_RUNTIME | AMAZON_TEXTRACT | AMAZON_COMPREHEND | AMAZON_COMPREHEND_MEDICAL | MICROSOFT_ONEDRIVE | MICROSOFT_SHAREPOINT | MICROSOFT_TEAMS | SAP_BUSINESSPARTNER | SAP_PRODUCTMASTERDATA | SAP_PHYSICALINVENTORY | SAP_BILLOFMATERIALS | SAP_MATERIALSTOCK | ZENDESK_SUITE | SMARTSHEET | SLACK | ASANA | BAMBOO_HR

Update requires: Replacement

VpcConnectionArn

The ARN of the VPC connection used for secure connectivity to the external service.

Required: No

Type: String

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the action connector.

CreatedTime

The timestamp when the action connector was created.

EnabledActions

The list of actions that are enabled for this connector.

LastUpdatedTime

The date and time when the action connector was last updated.

Status

The current status of the action connector.