Class CfnReplicator.KafkaClusterSaslOAuthBearerAuthenticationProperty

Details for client authentication using SASL/OAUTHBEARER.

Inheritance

object

CfnReplicator.KafkaClusterSaslOAuthBearerAuthenticationProperty

Implements

CfnReplicator.IKafkaClusterSaslOAuthBearerAuthenticationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.MSK

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnReplicator.KafkaClusterSaslOAuthBearerAuthenticationProperty : CfnReplicator.IKafkaClusterSaslOAuthBearerAuthenticationProperty

Syntax (vb)

Public Class CfnReplicator.KafkaClusterSaslOAuthBearerAuthenticationProperty Implements 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

Constructors

KafkaClusterSaslOAuthBearerAuthenticationProperty()

Details for client authentication using SASL/OAUTHBEARER.

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.

Constructors

KafkaClusterSaslOAuthBearerAuthenticationProperty()

Details for client authentication using SASL/OAUTHBEARER.

public KafkaClusterSaslOAuthBearerAuthenticationProperty()

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"
             };

Properties

ClientCredentials

Details for SASL/OAUTHBEARER using the standard client_credentials grant.

public object? ClientCredentials { get; set; }

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.

public object? ClientCredentialsAssertion { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnReplicator.IKafkaClusterOAuthClientCredentialsAssertionProperty

IamJwtBearer

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

public object? IamJwtBearer { get; set; }

Property Value

object

Remarks

An STS-vended JWT is used as the assertion.

Type union: either IResolvable or CfnReplicator.IKafkaClusterOAuthIamJwtBearerProperty

Scope

OAuth scope to request.

public string? Scope { get; set; }

Property Value

string

Remarks

Included in the token request if provided.

TokenEndpointAuthenticationMethod

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

public string TokenEndpointAuthenticationMethod { get; set; }

Property Value

string

Remarks

TokenEndpointTlsCertificateArn

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

public string? TokenEndpointTlsCertificateArn { get; set; }

Property Value

string

Remarks

Required only if the identity provider uses a private CA.

TokenEndpointUrl

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

public string TokenEndpointUrl { get; set; }