Class SalesforceOAuth2CredentialProviderProps

(experimental) Props for {@link OAuth2CredentialProvider.usingSalesforce}.

Inheritance
object
SalesforceOAuth2CredentialProviderProps
Inherited Members
Namespace: Amazon.CDK.AWS.Bedrock.Agentcore.Alpha
Assembly: Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.dll
Syntax (csharp)
public class SalesforceOAuth2CredentialProviderProps : ISalesforceOAuth2CredentialProviderProps, IOAuth2CredentialProviderFactoryBaseProps, IOAuth2CredentialProviderBaseProps, IOAuth2ClientCredentials
Syntax (vb)
Public Class SalesforceOAuth2CredentialProviderProps Implements ISalesforceOAuth2CredentialProviderProps, IOAuth2CredentialProviderFactoryBaseProps, IOAuth2CredentialProviderBaseProps, IOAuth2ClientCredentials
Remarks

Stability: Experimental

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.AWS.Bedrock.Agentcore.Alpha;
             using Amazon.CDK;

             SecretValue secretValue;

             var salesforceOAuth2CredentialProviderProps = new SalesforceOAuth2CredentialProviderProps {
                 ClientId = "clientId",
                 ClientSecret = secretValue,

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

Synopsis

Constructors

SalesforceOAuth2CredentialProviderProps()

(experimental) Props for {@link OAuth2CredentialProvider.usingSalesforce}.

Properties

ClientId

(experimental) OAuth2 client identifier.
ClientSecret

(experimental) OAuth2 client secret.
OAuth2CredentialProviderName

(experimental) Name of the credential provider.
Tags

(experimental) Tags for this credential provider.

Constructors

SalesforceOAuth2CredentialProviderProps()

(experimental) Props for {@link OAuth2CredentialProvider.usingSalesforce}.

public SalesforceOAuth2CredentialProviderProps()
Remarks

Stability: Experimental

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.AWS.Bedrock.Agentcore.Alpha;
             using Amazon.CDK;

             SecretValue secretValue;

             var salesforceOAuth2CredentialProviderProps = new SalesforceOAuth2CredentialProviderProps {
                 ClientId = "clientId",
                 ClientSecret = secretValue,

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

Properties

ClientId

(experimental) OAuth2 client identifier.

public string ClientId { get; set; }
Property Value

string

Remarks

Stability: Experimental

ClientSecret

(experimental) 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.

Stability: Experimental

OAuth2CredentialProviderName

(experimental) Name of the credential provider.

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

string

Remarks

Default: a name generated by CDK

Stability: Experimental

Tags

(experimental) Tags for this credential provider.

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

IDictionary<string, string>

Remarks

Default: - no tags

Stability: Experimental

Implements