create_oauth2_credential_provider¶
Operation¶
async
¶
create_oauth2_credential_provider(input: CreateOauth2CredentialProviderInput, plugins: list[Plugin] | None = None) -> CreateOauth2CredentialProviderOutput
Creates a new OAuth2 credential provider.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateOauth2CredentialProviderInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CreateOauth2CredentialProviderOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for CreateOauth2CredentialProviderInput structure.
Attributes¶
class-attribute
instance-attribute
¶
credential_provider_vendor: CredentialProviderVendorType | None = None
The vendor of the OAuth2 credential provider. This specifies which OAuth2 implementation to use.
class-attribute
instance-attribute
¶
name: str | None = None
The name of the OAuth2 credential provider. The name must be unique within your account.
class-attribute
instance-attribute
¶
oauth2_provider_config_input: Oauth2ProviderConfigInput | None = None
The configuration settings for the OAuth2 provider, including client ID, client secret, and other vendor-specific settings.
class-attribute
instance-attribute
¶
tags: dict[str, str] | None = None
A map of tag keys and values to assign to the OAuth2 credential provider. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
Output¶
dataclass
¶
Dataclass for CreateOauth2CredentialProviderOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
callback_url: str | None = None
Callback URL to register on the OAuth2 credential provider as an allowed callback URL. This URL is where the OAuth2 authorization server redirects users after they complete the authorization flow.
instance-attribute
¶
client_secret_arn: Secret
The Amazon Resource Name (ARN) of the client secret in Amazon Web Services Secrets Manager.
class-attribute
instance-attribute
¶
client_secret_json_key: str | None = None
The JSON key used to extract the client secret value from the Amazon Web Services Secrets Manager secret.
class-attribute
instance-attribute
¶
client_secret_source: SecretSourceType | None = None
The source type of the client secret. Either MANAGED if the secret is
managed by the service, or EXTERNAL if managed by the user in Amazon
Web Services Secrets Manager.
instance-attribute
¶
credential_provider_arn: str
The Amazon Resource Name (ARN) of the OAuth2 credential provider.
class-attribute
instance-attribute
¶
oauth2_provider_config_output: Oauth2ProviderConfigOutput | None = None
Contains the output configuration for an OAuth2 provider.