Show / Hide Table of Contents

Interface CfnReplicator.IKafkaClusterSaslOAuthBearerAuthenticationProperty

Details for client authentication using SASL/OAUTHBEARER.

Namespace: Amazon.CDK.AWS.MSK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnReplicator.IKafkaClusterSaslOAuthBearerAuthenticationProperty
Syntax (vb)
Public Interface CfnReplicator.IKafkaClusterSaslOAuthBearerAuthenticationProperty
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-replicator-kafkaclustersasloauthbearerauthentication.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.AWS.MSK;

             var kafkaClusterSaslOAuthBearerAuthenticationProperty = new KafkaClusterSaslOAuthBearerAuthenticationProperty {
                 TokenEndpointAuthenticationMethod = "tokenEndpointAuthenticationMethod",
                 TokenEndpointUrl = "tokenEndpointUrl",

                 // the properties below are optional
                 ClientCredentials = new KafkaClusterOAuthClientCredentialsProperty {
                     TokenRequestSecretArn = "tokenRequestSecretArn"
                 },
                 ClientCredentialsAssertion = new KafkaClusterOAuthClientCredentialsAssertionProperty {
                     Audience = "audience",
                     SigningAlgorithm = "signingAlgorithm",

                     // the properties below are optional
                     TokenRequestSecretArn = "tokenRequestSecretArn"
                 },
                 IamJwtBearer = new KafkaClusterOAuthIamJwtBearerProperty {
                     Audience = "audience",
                     SigningAlgorithm = "signingAlgorithm",

                     // the properties below are optional
                     TokenRequestSecretArn = "tokenRequestSecretArn"
                 },
                 Scope = "scope",
                 TokenEndpointTlsCertificateArn = "tokenEndpointTlsCertificateArn"
             };

Synopsis

Properties

ClientCredentials

Details for SASL/OAUTHBEARER using the standard client_credentials grant.

ClientCredentialsAssertion

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

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

Scope

OAuth scope to request.

TokenEndpointAuthenticationMethod

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

TokenEndpointTlsCertificateArn

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

TokenEndpointUrl

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

Properties

ClientCredentials

Details for SASL/OAUTHBEARER using the standard client_credentials grant.

object? ClientCredentials { get; }
Property Value

object

Remarks

The referenced secret must contain client_id and client_secret.

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

Type union: either IResolvable or CfnReplicator.IKafkaClusterOAuthClientCredentialsProperty

ClientCredentialsAssertion

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.

object? ClientCredentialsAssertion { get; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnReplicator.IKafkaClusterOAuthClientCredentialsAssertionProperty

IamJwtBearer

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

object? IamJwtBearer { get; }
Property Value

object

Remarks

An STS-vended JWT is used as the assertion.

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

Type union: either IResolvable or CfnReplicator.IKafkaClusterOAuthIamJwtBearerProperty

Scope

OAuth scope to request.

string? Scope { get; }
Property Value

string

Remarks

Included in the token request if provided.

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

TokenEndpointAuthenticationMethod

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

string TokenEndpointAuthenticationMethod { get; }
Property Value

string

Remarks

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

TokenEndpointTlsCertificateArn

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

string? TokenEndpointTlsCertificateArn { get; }
Property Value

string

Remarks

Required only if the identity provider uses a private CA.

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

TokenEndpointUrl

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

string TokenEndpointUrl { get; }
Property Value

string

Remarks

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

Back to top Generated by DocFX