interface KafkaClusterSaslOAuthBearerAuthenticationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.MSK.CfnReplicator.KafkaClusterSaslOAuthBearerAuthenticationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsmsk#CfnReplicator_KafkaClusterSaslOAuthBearerAuthenticationProperty`
Java	`software.amazon.awscdk.services.msk.CfnReplicator.KafkaClusterSaslOAuthBearerAuthenticationProperty`
Python	`aws_cdk.aws_msk.CfnReplicator.KafkaClusterSaslOAuthBearerAuthenticationProperty`
TypeScript	`aws-cdk-lib` » `aws_msk` » `CfnReplicator` » `KafkaClusterSaslOAuthBearerAuthenticationProperty`

Details for client authentication using SASL/OAUTHBEARER.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_msk as msk } from 'aws-cdk-lib';
const kafkaClusterSaslOAuthBearerAuthenticationProperty: msk.CfnReplicator.KafkaClusterSaslOAuthBearerAuthenticationProperty = {
  tokenEndpointAuthenticationMethod: 'tokenEndpointAuthenticationMethod',
  tokenEndpointUrl: 'tokenEndpointUrl',

  // the properties below are optional
  clientCredentials: {
    tokenRequestSecretArn: 'tokenRequestSecretArn',
  },
  clientCredentialsAssertion: {
    audience: 'audience',
    signingAlgorithm: 'signingAlgorithm',

    // the properties below are optional
    tokenRequestSecretArn: 'tokenRequestSecretArn',
  },
  iamJwtBearer: {
    audience: 'audience',
    signingAlgorithm: 'signingAlgorithm',

    // the properties below are optional
    tokenRequestSecretArn: 'tokenRequestSecretArn',
  },
  scope: 'scope',
  tokenEndpointTlsCertificateArn: 'tokenEndpointTlsCertificateArn',
};

Properties

Name	Type	Description
tokenEndpointAuthenticationMethod	`string`	How client credentials are sent to the identity provider's token endpoint.
tokenEndpointUrl	`string`	The HTTPS URL of the OAuth token endpoint that vends OAuth Bearer tokens per RFC 6749.
clientCredentials?	`IResolvable` `\|` `KafkaClusterOAuthClientCredentialsProperty`	Details for SASL/OAUTHBEARER using the standard client_credentials grant.
clientCredentialsAssertion?	`IResolvable` `\|` `KafkaClusterOAuthClientCredentialsAssertionProperty`	Details for SASL/OAUTHBEARER using the client credentials grant with a JWT client assertion (RFC 7521/7523 Section 2.2). An STS-vended JWT is used as the client_assertion.
iamJwtBearer?	`IResolvable` `\|` `KafkaClusterOAuthIamJwtBearerProperty`	Details for SASL/OAUTHBEARER using the JWT Bearer assertion grant (RFC 7523).
scope?	`string`	OAuth scope to request.
tokenEndpointTlsCertificateArn?	`string`	Secrets Manager ARN containing a custom CA certificate for the identity provider.

tokenEndpointAuthenticationMethod

Type: string

How client credentials are sent to the identity provider's token endpoint.

tokenEndpointUrl

Type: string

The HTTPS URL of the OAuth token endpoint that vends OAuth Bearer tokens per RFC 6749.

clientCredentials?

Type: IResolvable | KafkaClusterOAuthClientCredentialsProperty (optional)

Details for SASL/OAUTHBEARER using the standard client_credentials grant.

The referenced secret must contain client_id and client_secret.

clientCredentialsAssertion?

Type: IResolvable | KafkaClusterOAuthClientCredentialsAssertionProperty (optional)

Details for SASL/OAUTHBEARER using the client credentials grant with a JWT client assertion (RFC 7521/7523 Section 2.2). An STS-vended JWT is used as the client_assertion.

iamJwtBearer?

Type: IResolvable | KafkaClusterOAuthIamJwtBearerProperty (optional)

Details for SASL/OAUTHBEARER using the JWT Bearer assertion grant (RFC 7523).

An STS-vended JWT is used as the assertion.

scope?

Type: string (optional)

OAuth scope to request.

Included in the token request if provided.

tokenEndpointTlsCertificateArn?