Show / Hide Table of Contents

Class TwitchOAuth2CredentialProviderProps

Props for {@link OAuth2CredentialProvider.usingTwitch}.

Inheritance
object
TwitchOAuth2CredentialProviderProps
Implements
ITwitchOAuth2CredentialProviderProps
IOAuth2CredentialProviderFactoryBaseProps
IOAuth2CredentialProviderBaseProps
IOAuth2ClientCredentials
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.BedrockAgentCore
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class TwitchOAuth2CredentialProviderProps : ITwitchOAuth2CredentialProviderProps, IOAuth2CredentialProviderFactoryBaseProps, IOAuth2CredentialProviderBaseProps, IOAuth2ClientCredentials
Syntax (vb)
Public Class TwitchOAuth2CredentialProviderProps Implements ITwitchOAuth2CredentialProviderProps, IOAuth2CredentialProviderFactoryBaseProps, IOAuth2CredentialProviderBaseProps, IOAuth2ClientCredentials
Remarks

See: https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/identity-idp-twitch.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;
             using Amazon.CDK.AWS.BedrockAgentCore;

             SecretValue secretValue;

             var twitchOAuth2CredentialProviderProps = new TwitchOAuth2CredentialProviderProps {
                 ClientId = "clientId",
                 ClientSecret = secretValue,

                 // the properties below are optional
                 OAuth2CredentialProviderName = "oAuth2CredentialProviderName",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             };

Synopsis

Constructors

TwitchOAuth2CredentialProviderProps()

Props for {@link OAuth2CredentialProvider.usingTwitch}.

Properties

ClientId

OAuth2 client identifier.

ClientSecret

OAuth2 client secret.

OAuth2CredentialProviderName

Name of the credential provider.

Tags

Tags for this credential provider.

Constructors

TwitchOAuth2CredentialProviderProps()

Props for {@link OAuth2CredentialProvider.usingTwitch}.

public TwitchOAuth2CredentialProviderProps()
Remarks

See: https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/identity-idp-twitch.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;
             using Amazon.CDK.AWS.BedrockAgentCore;

             SecretValue secretValue;

             var twitchOAuth2CredentialProviderProps = new TwitchOAuth2CredentialProviderProps {
                 ClientId = "clientId",
                 ClientSecret = secretValue,

                 // the properties below are optional
                 OAuth2CredentialProviderName = "oAuth2CredentialProviderName",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             };

Properties

ClientId

OAuth2 client identifier.

public string ClientId { get; set; }
Property Value

string

Remarks

See: https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/identity-idp-twitch.html

ExampleMetadata: fixture=_generated

ClientSecret

OAuth2 client secret.

public SecretValue ClientSecret { get; set; }
Property Value

SecretValue

Remarks

NOTE: The client secret will be included in the CloudFormation template as part of synthesis. The service stores the secret in Secrets Manager after creation, but the value is visible in the template and deployment history. Use SecretValue.unsafePlainText() to explicitly acknowledge plaintext, or pass a reference from another construct to avoid embedding the literal value.

OAuth2CredentialProviderName

Name of the credential provider.

public string? OAuth2CredentialProviderName { get; set; }
Property Value

string

Remarks

Default: a name generated by CDK

Tags

Tags for this credential provider.

public IDictionary<string, string>? Tags { get; set; }
Property Value

IDictionary<string, string>

Remarks

Default: - no tags

Implements

ITwitchOAuth2CredentialProviderProps
IOAuth2CredentialProviderFactoryBaseProps
IOAuth2CredentialProviderBaseProps
IOAuth2ClientCredentials
Back to top Generated by DocFX