Skip to content
v2.275.0

Oauth2ProviderConfigInputProperty Struct ​

Input configuration for an OAuth2 provider.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrockagentcore as bedrockagentcore } from 'aws-cdk-lib';
const oauth2ProviderConfigInputProperty: bedrockagentcore.CfnOAuth2CredentialProvider.Oauth2ProviderConfigInputProperty = {
  atlassianOauth2ProviderConfig: {
    clientId: 'clientId',

    // the properties below are optional
    clientSecret: 'clientSecret',
    clientSecretConfig: {
      jsonKey: 'jsonKey',
      secretId: 'secretId',
    },
    clientSecretSource: 'clientSecretSource',
  },
  customOauth2ProviderConfig: {
    oauthDiscovery: {
      authorizationServerMetadata: {
        authorizationEndpoint: 'authorizationEndpoint',
        issuer: 'issuer',
        tokenEndpoint: 'tokenEndpoint',

        // the properties below are optional
        responseTypes: ['responseTypes'],
      },
      discoveryUrl: 'discoveryUrl',
    },

    // the properties below are optional
    clientAuthenticationMethod: 'clientAuthenticationMethod',
    clientId: 'clientId',
    clientSecret: 'clientSecret',
    clientSecretConfig: {
      jsonKey: 'jsonKey',
      secretId: 'secretId',
    },
    clientSecretSource: 'clientSecretSource',
    onBehalfOfTokenExchangeConfig: {
      grantType: 'grantType',

      // the properties below are optional
      tokenExchangeGrantTypeConfig: {
        actorTokenContent: 'actorTokenContent',

        // the properties below are optional
        actorTokenScopes: ['actorTokenScopes'],
      },
    },
    privateEndpoint: {
      managedVpcResource: {
        endpointIpAddressType: 'endpointIpAddressType',
        subnetIds: ['subnetIds'],
        vpcIdentifier: 'vpcIdentifier',

        // the properties below are optional
        routingDomain: 'routingDomain',
        securityGroupIds: ['securityGroupIds'],
        tags: {
          tagsKey: 'tags',
        },
      },
      selfManagedLatticeResource: {
        resourceConfigurationIdentifier: 'resourceConfigurationIdentifier',
      },
    },
    privateEndpointOverrides: [{
      domain: 'domain',
      privateEndpoint: {
        managedVpcResource: {
          endpointIpAddressType: 'endpointIpAddressType',
          subnetIds: ['subnetIds'],
          vpcIdentifier: 'vpcIdentifier',

          // the properties below are optional
          routingDomain: 'routingDomain',
          securityGroupIds: ['securityGroupIds'],
          tags: {
            tagsKey: 'tags',
          },
        },
        selfManagedLatticeResource: {
          resourceConfigurationIdentifier: 'resourceConfigurationIdentifier',
        },
      },
    }],
    privateKeyJwtConfig: {
      additionalHeaderClaims: {
        additionalHeaderClaimsKey: 'additionalHeaderClaims',
      },
      additionalPayloadClaims: {
        additionalPayloadClaimsKey: 'additionalPayloadClaims',
      },
      privateKeySource: {
        kmsKeySource: {
          kmsKeyArn: 'kmsKeyArn',
        },
      },
      signingAlgorithm: 'signingAlgorithm',
    },
  },
  githubOauth2ProviderConfig: {
    clientId: 'clientId',

    // the properties below are optional
    clientSecret: 'clientSecret',
    clientSecretConfig: {
      jsonKey: 'jsonKey',
      secretId: 'secretId',
    },
    clientSecretSource: 'clientSecretSource',
  },
  googleOauth2ProviderConfig: {
    clientId: 'clientId',

    // the properties below are optional
    clientSecret: 'clientSecret',
    clientSecretConfig: {
      jsonKey: 'jsonKey',
      secretId: 'secretId',
    },
    clientSecretSource: 'clientSecretSource',
  },
  includedOauth2ProviderConfig: {
    clientId: 'clientId',

    // the properties below are optional
    authorizationEndpoint: 'authorizationEndpoint',
    clientSecret: 'clientSecret',
    clientSecretConfig: {
      jsonKey: 'jsonKey',
      secretId: 'secretId',
    },
    clientSecretSource: 'clientSecretSource',
    issuer: 'issuer',
    tokenEndpoint: 'tokenEndpoint',
  },
  linkedinOauth2ProviderConfig: {
    clientId: 'clientId',

    // the properties below are optional
    clientSecret: 'clientSecret',
    clientSecretConfig: {
      jsonKey: 'jsonKey',
      secretId: 'secretId',
    },
    clientSecretSource: 'clientSecretSource',
  },
  microsoftOauth2ProviderConfig: {
    clientId: 'clientId',

    // the properties below are optional
    clientSecret: 'clientSecret',
    clientSecretConfig: {
      jsonKey: 'jsonKey',
      secretId: 'secretId',
    },
    clientSecretSource: 'clientSecretSource',
    tenantId: 'tenantId',
  },
  salesforceOauth2ProviderConfig: {
    clientId: 'clientId',

    // the properties below are optional
    clientSecret: 'clientSecret',
    clientSecretConfig: {
      jsonKey: 'jsonKey',
      secretId: 'secretId',
    },
    clientSecretSource: 'clientSecretSource',
  },
  slackOauth2ProviderConfig: {
    clientId: 'clientId',

    // the properties below are optional
    clientSecret: 'clientSecret',
    clientSecretConfig: {
      jsonKey: 'jsonKey',
      secretId: 'secretId',
    },
    clientSecretSource: 'clientSecretSource',
  },
};

Properties ​

atlassianOauth2ProviderConfigoptionalIResolvable | CfnOAuth2CredentialProvider.AtlassianOauth2ProviderConfigInputPropertyatlassian_oauth2_provider_configoptionaltyping.Union[IResolvable, AtlassianOauth2ProviderConfigInputProperty]atlassianOauth2ProviderConfigoptionalIResolvableAtlassianOauth2ProviderConfigoptionalIResolvableAtlassianOauth2ProviderConfigoptionalinterface{}#
Input configuration for an Atlassian OAuth2 provider.
customOauth2ProviderConfigoptionalIResolvable | CfnOAuth2CredentialProvider.CustomOauth2ProviderConfigInputPropertycustom_oauth2_provider_configoptionaltyping.Union[IResolvable, CustomOauth2ProviderConfigInputProperty]customOauth2ProviderConfigoptionalIResolvableCustomOauth2ProviderConfigoptionalIResolvableCustomOauth2ProviderConfigoptionalinterface{}#
Input configuration for a custom OAuth2 provider.
githubOauth2ProviderConfigoptionalIResolvable | CfnOAuth2CredentialProvider.GithubOauth2ProviderConfigInputPropertygithub_oauth2_provider_configoptionaltyping.Union[IResolvable, GithubOauth2ProviderConfigInputProperty]githubOauth2ProviderConfigoptionalIResolvableGithubOauth2ProviderConfigoptionalIResolvableGithubOauth2ProviderConfigoptionalinterface{}#
Input configuration for a GitHub OAuth2 provider.
googleOauth2ProviderConfigoptionalIResolvable | CfnOAuth2CredentialProvider.GoogleOauth2ProviderConfigInputPropertygoogle_oauth2_provider_configoptionaltyping.Union[IResolvable, GoogleOauth2ProviderConfigInputProperty]googleOauth2ProviderConfigoptionalIResolvableGoogleOauth2ProviderConfigoptionalIResolvableGoogleOauth2ProviderConfigoptionalinterface{}#
Input configuration for a Google OAuth2 provider.
includedOauth2ProviderConfigoptionalIResolvable | CfnOAuth2CredentialProvider.IncludedOauth2ProviderConfigInputPropertyincluded_oauth2_provider_configoptionaltyping.Union[IResolvable, IncludedOauth2ProviderConfigInputProperty]includedOauth2ProviderConfigoptionalIResolvableIncludedOauth2ProviderConfigoptionalIResolvableIncludedOauth2ProviderConfigoptionalinterface{}#
Input configuration for a supported non-custom OAuth2 provider.
linkedinOauth2ProviderConfigoptionalIResolvable | CfnOAuth2CredentialProvider.LinkedinOauth2ProviderConfigInputPropertylinkedin_oauth2_provider_configoptionaltyping.Union[IResolvable, LinkedinOauth2ProviderConfigInputProperty]linkedinOauth2ProviderConfigoptionalIResolvableLinkedinOauth2ProviderConfigoptionalIResolvableLinkedinOauth2ProviderConfigoptionalinterface{}#
Input configuration for a LinkedIn OAuth2 provider.
microsoftOauth2ProviderConfigoptionalIResolvable | CfnOAuth2CredentialProvider.MicrosoftOauth2ProviderConfigInputPropertymicrosoft_oauth2_provider_configoptionaltyping.Union[IResolvable, MicrosoftOauth2ProviderConfigInputProperty]microsoftOauth2ProviderConfigoptionalIResolvableMicrosoftOauth2ProviderConfigoptionalIResolvableMicrosoftOauth2ProviderConfigoptionalinterface{}#
Input configuration for a Microsoft OAuth2 provider.
salesforceOauth2ProviderConfigoptionalIResolvable | CfnOAuth2CredentialProvider.SalesforceOauth2ProviderConfigInputPropertysalesforce_oauth2_provider_configoptionaltyping.Union[IResolvable, SalesforceOauth2ProviderConfigInputProperty]salesforceOauth2ProviderConfigoptionalIResolvableSalesforceOauth2ProviderConfigoptionalIResolvableSalesforceOauth2ProviderConfigoptionalinterface{}#
Input configuration for a Salesforce OAuth2 provider.
slackOauth2ProviderConfigoptionalIResolvable | CfnOAuth2CredentialProvider.SlackOauth2ProviderConfigInputPropertyslack_oauth2_provider_configoptionaltyping.Union[IResolvable, SlackOauth2ProviderConfigInputProperty]slackOauth2ProviderConfigoptionalIResolvableSlackOauth2ProviderConfigoptionalIResolvableSlackOauth2ProviderConfigoptionalinterface{}#
Input configuration for a Slack OAuth2 provider.