OAuthClientApplication
An OAuth client application that is used to authenticate connections to a data source through an OAuth identity provider.
Contents
Note
In the following list, the required parameters are described first.
- Arn
-
The Amazon Resource Name (ARN) of the OAuthClientApplication.
Type: String
Required: No
- CreatedTime
-
The time that the OAuthClientApplication was created.
Type: Timestamp
Required: No
- DataSourceType
-
The type of data source that the OAuthClientApplication is used with. Valid values are
SNOWFLAKE.Type: String
Valid Values:
ADOBE_ANALYTICS | AMAZON_ELASTICSEARCH | ATHENA | AURORA | AURORA_POSTGRESQL | AWS_IOT_ANALYTICS | GITHUB | JIRA | MARIADB | MYSQL | ORACLE | POSTGRESQL | PRESTO | REDSHIFT | S3 | S3_TABLES | SALESFORCE | SERVICENOW | SNOWFLAKE | SPARK | SQLSERVER | TERADATA | TWITTER | TIMESTREAM | AMAZON_OPENSEARCH | EXASOL | DATABRICKS | STARBURST | TRINO | BIGQUERY | GOOGLESHEETS | GOOGLE_DRIVE | CONFLUENCE | SHAREPOINT | ONE_DRIVE | WEB_CRAWLER | S3_KNOWLEDGE_BASE | QBUSINESSRequired: No
- IdentityProviderVpcConnectionProperties
-
VPC connection properties.
Type: VpcConnectionProperties object
Required: No
- LastUpdatedTime
-
The time that the OAuthClientApplication was last updated.
Type: Timestamp
Required: No
- Name
-
The display name of the OAuthClientApplication.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No
- OAuthAuthorizationEndpointUrl
-
The authorization endpoint URL of the identity provider that is used to obtain authorization codes.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^https://[^\p{Cc}]+Required: No
- OAuthClientApplicationId
-
The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[^/][^\p{Cc}]*Required: No
- OAuthClientAuthenticationType
-
The OAuth client authentication type used by the OAuthClientApplication. Valid values are
TOKEN.Type: String
Valid Values:
TOKENRequired: No
- OAuthScopes
-
The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the identity provider.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Pattern:
[^\p{Cc}]+Required: No
- OAuthTokenEndpointUrl
-
The token endpoint URL of the identity provider that is used to obtain access tokens.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^https://[^\p{Cc}]+Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: