2.269.0

interface KafkaClusterSaslOAuthBearerAuthenticationProperty

LanguageType name
.NETAmazon.CDK.CfnPropertyMixins.AWS.MSK.CfnReplicatorPropsMixin.KafkaClusterSaslOAuthBearerAuthenticationProperty
Gogithub.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsmsk#CfnReplicatorPropsMixin_KafkaClusterSaslOAuthBearerAuthenticationProperty
Javasoftware.amazon.awscdk.cfnpropertymixins.services.msk.CfnReplicatorPropsMixin.KafkaClusterSaslOAuthBearerAuthenticationProperty
Pythonaws_cdk.cfn_property_mixins.aws_msk.CfnReplicatorPropsMixin.KafkaClusterSaslOAuthBearerAuthenticationProperty
TypeScript @aws-cdk/cfn-property-mixins » aws_msk » CfnReplicatorPropsMixin » KafkaClusterSaslOAuthBearerAuthenticationProperty

Details for client authentication using SASL/OAUTHBEARER.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-kafkaclustersasloauthbearerauthentication.html

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/cfn-property-mixins';
const kafkaClusterSaslOAuthBearerAuthenticationProperty: msk.CfnReplicatorPropsMixin.KafkaClusterSaslOAuthBearerAuthenticationProperty = {
  clientCredentials: {
    tokenRequestSecretArn: 'tokenRequestSecretArn',
  },
  clientCredentialsAssertion: {
    audience: 'audience',
    signingAlgorithm: 'signingAlgorithm',
    tokenRequestSecretArn: 'tokenRequestSecretArn',
  },
  iamJwtBearer: {
    audience: 'audience',
    signingAlgorithm: 'signingAlgorithm',
    tokenRequestSecretArn: 'tokenRequestSecretArn',
  },
  scope: 'scope',
  tokenEndpointAuthenticationMethod: 'tokenEndpointAuthenticationMethod',
  tokenEndpointTlsCertificateArn: 'tokenEndpointTlsCertificateArn',
  tokenEndpointUrl: 'tokenEndpointUrl',
};

Properties

NameTypeDescription
clientCredentials?IResolvable | KafkaClusterOAuthClientCredentialsPropertyDetails for SASL/OAUTHBEARER using the standard client_credentials grant.
clientCredentialsAssertion?IResolvable | KafkaClusterOAuthClientCredentialsAssertionPropertyDetails 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 | KafkaClusterOAuthIamJwtBearerPropertyDetails for SASL/OAUTHBEARER using the JWT Bearer assertion grant (RFC 7523).
scope?stringOAuth scope to request.
tokenEndpointAuthenticationMethod?stringHow client credentials are sent to the identity provider's token endpoint.
tokenEndpointTlsCertificateArn?stringSecrets Manager ARN containing a custom CA certificate for the identity provider.
tokenEndpointUrl?stringThe 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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-kafkaclustersasloauthbearerauthentication.html#cfn-msk-replicator-kafkaclustersasloauthbearerauthentication-clientcredentials

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-kafkaclustersasloauthbearerauthentication.html#cfn-msk-replicator-kafkaclustersasloauthbearerauthentication-clientcredentialsassertion

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-kafkaclustersasloauthbearerauthentication.html#cfn-msk-replicator-kafkaclustersasloauthbearerauthentication-iamjwtbearer

scope?

Type: string (optional)

OAuth scope to request.

Included in the token request if provided.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-kafkaclustersasloauthbearerauthentication.html#cfn-msk-replicator-kafkaclustersasloauthbearerauthentication-scope

tokenEndpointAuthenticationMethod?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-kafkaclustersasloauthbearerauthentication.html#cfn-msk-replicator-kafkaclustersasloauthbearerauthentication-tokenendpointauthenticationmethod

tokenEndpointTlsCertificateArn?

Type: string (optional)

Secrets Manager ARN containing a custom CA certificate for the identity provider.

Required only if the identity provider uses a private CA.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-kafkaclustersasloauthbearerauthentication.html#cfn-msk-replicator-kafkaclustersasloauthbearerauthentication-tokenendpointtlscertificatearn

tokenEndpointUrl?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-kafkaclustersasloauthbearerauthentication.html#cfn-msk-replicator-kafkaclustersasloauthbearerauthentication-tokenendpointurl

← PreviousNext →