Package software.amazon.awscdk.services.msk

Interface CfnReplicator.KafkaClusterSaslOAuthBearerAuthenticationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnReplicator.KafkaClusterSaslOAuthBearerAuthenticationProperty.Jsii$Proxy

Enclosing class:

CfnReplicator

@Stability(Stable)
public static interface CfnReplicator.KafkaClusterSaslOAuthBearerAuthenticationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.msk.*;
 KafkaClusterSaslOAuthBearerAuthenticationProperty kafkaClusterSaslOAuthBearerAuthenticationProperty = KafkaClusterSaslOAuthBearerAuthenticationProperty.builder()
         .tokenEndpointAuthenticationMethod("tokenEndpointAuthenticationMethod")
         .tokenEndpointUrl("tokenEndpointUrl")
         // the properties below are optional
         .clientCredentials(KafkaClusterOAuthClientCredentialsProperty.builder()
                 .tokenRequestSecretArn("tokenRequestSecretArn")
                 .build())
         .clientCredentialsAssertion(KafkaClusterOAuthClientCredentialsAssertionProperty.builder()
                 .audience("audience")
                 .signingAlgorithm("signingAlgorithm")
                 // the properties below are optional
                 .tokenRequestSecretArn("tokenRequestSecretArn")
                 .build())
         .iamJwtBearer(KafkaClusterOAuthIamJwtBearerProperty.builder()
                 .audience("audience")
                 .signingAlgorithm("signingAlgorithm")
                 // the properties below are optional
                 .tokenRequestSecretArn("tokenRequestSecretArn")
                 .build())
         .scope("scope")
         .tokenEndpointTlsCertificateArn("tokenEndpointTlsCertificateArn")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnReplicator.KafkaClusterSaslOAuthBearerAuthenticationProperty.Builder	A builder for CfnReplicator.KafkaClusterSaslOAuthBearerAuthenticationProperty
static final class	CfnReplicator.KafkaClusterSaslOAuthBearerAuthenticationProperty.Jsii$Proxy	An implementation for CfnReplicator.KafkaClusterSaslOAuthBearerAuthenticationProperty

Method Summary

Modifier and Type	Method	Description
static CfnReplicator.KafkaClusterSaslOAuthBearerAuthenticationProperty.Builder	builder()
default Object	getClientCredentials()	Details for SASL/OAUTHBEARER using the standard client_credentials grant.
default Object	getClientCredentialsAssertion()	Details for SASL/OAUTHBEARER using the client credentials grant with a JWT client assertion (RFC 7521/7523 Section 2.2).
default Object	getIamJwtBearer()	Details for SASL/OAUTHBEARER using the JWT Bearer assertion grant (RFC 7523).
default String	getScope()	OAuth scope to request.
String	getTokenEndpointAuthenticationMethod()	How client credentials are sent to the identity provider's token endpoint.
default String	getTokenEndpointTlsCertificateArn()	Secrets Manager ARN containing a custom CA certificate for the identity provider.
String	getTokenEndpointUrl()	The HTTPS URL of the OAuth token endpoint that vends OAuth Bearer tokens per RFC 6749.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTokenEndpointAuthenticationMethod

@Stability(Stable)
@NotNull
String getTokenEndpointAuthenticationMethod()

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

getTokenEndpointUrl

@Stability(Stable)
@NotNull
String getTokenEndpointUrl()

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

getClientCredentials

@Stability(Stable)
@Nullable
default Object getClientCredentials()

Details for SASL/OAUTHBEARER using the standard client_credentials grant.

The referenced secret must contain client_id and client_secret.

Returns union: either IResolvable or CfnReplicator.KafkaClusterOAuthClientCredentialsProperty

See Also:

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

getClientCredentialsAssertion

@Stability(Stable)
@Nullable
default Object getClientCredentialsAssertion()

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.

Returns union: either IResolvable or CfnReplicator.KafkaClusterOAuthClientCredentialsAssertionProperty

See Also:

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

getIamJwtBearer

@Stability(Stable)
@Nullable
default Object getIamJwtBearer()

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

An STS-vended JWT is used as the assertion.

Returns union: either IResolvable or CfnReplicator.KafkaClusterOAuthIamJwtBearerProperty

See Also:

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

getScope

@Stability(Stable)
@Nullable
default String getScope()

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

getTokenEndpointTlsCertificateArn

@Stability(Stable)
@Nullable
default String getTokenEndpointTlsCertificateArn()

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

builder

@Stability(Stable)
static CfnReplicator.KafkaClusterSaslOAuthBearerAuthenticationProperty.Builder builder()

Returns:

a CfnReplicator.KafkaClusterSaslOAuthBearerAuthenticationProperty.Builder of CfnReplicator.KafkaClusterSaslOAuthBearerAuthenticationProperty