AWS::QuickSight::OAuthClientApplication - AWS CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

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::OAuthClientApplication

Creates an OAuthClientApplication.

Syntax

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

JSON

{
  "Type" : "AWS::QuickSight::OAuthClientApplication",
  "Properties" : {
      "ClientId" : String,
      "ClientSecret" : String,
      "DataSourceType" : String,
      "IdentityProviderVpcConnectionProperties" : IdentityProviderVpcConnectionProperties,
      "Name" : String,
      "OAuthAuthorizationEndpointUrl" : String,
      "OAuthClientApplicationId" : String,
      "OAuthClientAuthenticationType" : String,
      "OAuthScopes" : String,
      "OAuthTokenEndpointUrl" : String,
      "Tags" : [ Tag, ... ]
    }
}

Properties

ClientId

Property description not available.

Required: No

Type: String

Minimum: 1

Maximum: 2048

Update requires: No interruption

ClientSecret

Property description not available.

Required: No

Type: String

Minimum: 1

Maximum: 2048

Update requires: No interruption

DataSourceType

The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE.

Required: No

Type: String

Allowed values: ADOBE_ANALYTICS | AMAZON_ELASTICSEARCH | AMAZON_OPENSEARCH | ATHENA | AURORA | AURORA_POSTGRESQL | AWS_IOT_ANALYTICS | BIGQUERY | CONFLUENCE | DATABRICKS | EXASOL | GITHUB | GOOGLESHEETS | GOOGLE_DRIVE | JIRA | MARIADB | MYSQL | ONE_DRIVE | ORACLE | POSTGRESQL | PRESTO | QBUSINESS | REDSHIFT | S3 | S3_KNOWLEDGE_BASE | S3_TABLES | SALESFORCE | SERVICENOW | SHAREPOINT | SNOWFLAKE | SPARK | SQLSERVER | STARBURST | TERADATA | TIMESTREAM | TRINO | TWITTER | WEB_CRAWLER

Update requires: No interruption

IdentityProviderVpcConnectionProperties

VPC connection properties.

Required: No

Type: IdentityProviderVpcConnectionProperties

Update requires: No interruption

Name

The display name of the OAuthClientApplication.

Required: Yes

Type: String

Minimum: 1

Maximum: 2048

Update requires: No interruption

OAuthAuthorizationEndpointUrl

The authorization endpoint URL of the identity provider that is used to obtain authorization codes.

Required: No

Type: String

Minimum: 1

Maximum: 2048

Update requires: No interruption

OAuthClientApplicationId

The ID of the OAuthClientApplication. This ID is unique per AWS Region for each AWS account.

Required: Yes

Type: String

Pattern: [^/][^\u0000-\u001f]*

Minimum: 1

Maximum: 256

Update requires: Replacement

OAuthClientAuthenticationType

The OAuth client authentication type used by the OAuthClientApplication. Valid values are TOKEN.

Required: Yes

Type: String

Allowed values: TOKEN

Update requires: Replacement

OAuthScopes

The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the identity provider.

Required: No

Type: String

Minimum: 1

Maximum: 4096

Update requires: No interruption

OAuthTokenEndpointUrl

The token endpoint URL of the identity provider that is used to obtain access tokens.

Required: Yes

Type: String

Minimum: 1

Maximum: 2048

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Array of Tag

Maximum: 200

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the OAuthClientApplication.

CreatedTime

The time that the OAuthClientApplication was created.

LastUpdatedTime

The time that the OAuthClientApplication was last updated.