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, ... ]} }
YAML
Type: AWS::QuickSight::OAuthClientApplication Properties: ClientId:StringClientSecret:StringDataSourceType:StringIdentityProviderVpcConnectionProperties:IdentityProviderVpcConnectionPropertiesName:StringOAuthAuthorizationEndpointUrl:StringOAuthClientApplicationId:StringOAuthClientAuthenticationType:StringOAuthScopes:StringOAuthTokenEndpointUrl:StringTags:- Tag
Properties
ClientIdProperty description not available.
Required: No
Type: String
Minimum:
1Maximum:
2048Update requires: No interruption
ClientSecretProperty description not available.
Required: No
Type: String
Minimum:
1Maximum:
2048Update 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_CRAWLERUpdate 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:
1Maximum:
2048Update requires: No interruption
-
The authorization endpoint URL of the identity provider that is used to obtain authorization codes.
Required: No
Type: String
Minimum:
1Maximum:
2048Update 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:
1Maximum:
256Update requires: Replacement
OAuthClientAuthenticationType-
The OAuth client authentication type used by the OAuthClientApplication. Valid values are
TOKEN.Required: Yes
Type: String
Allowed values:
TOKENUpdate 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:
1Maximum:
4096Update requires: No interruption
OAuthTokenEndpointUrl-
The token endpoint URL of the identity provider that is used to obtain access tokens.
Required: Yes
Type: String
Minimum:
1Maximum:
2048Update requires: No interruption
Property description not available.
Required: No
Type: Array of Tag
Maximum:
200Update 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.