Package software.amazon.awscdk.services.quicksight

Interface CfnDataSource.OAuthParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.OAuthParametersProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(Stable)
public static interface CfnDataSource.OAuthParametersProperty
extends software.amazon.jsii.JsiiSerializable

An object that contains information needed to create a data source connection that uses OAuth client credentials.

This option is available for data source connections that are made with Snowflake and Starburst.

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.quicksight.*;
 OAuthParametersProperty oAuthParametersProperty = OAuthParametersProperty.builder()
         .tokenProviderUrl("tokenProviderUrl")
         // the properties below are optional
         .identityProviderResourceUri("identityProviderResourceUri")
         .identityProviderVpcConnectionProperties(VpcConnectionPropertiesProperty.builder()
                 .vpcConnectionArn("vpcConnectionArn")
                 .build())
         .oAuthScope("oAuthScope")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-oauthparameters.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataSource.OAuthParametersProperty.Builder	builder()
default String	getIdentityProviderResourceUri()	The resource uri of the identity provider.
default Object	getIdentityProviderVpcConnectionProperties()	VPC connection properties.
default String	getOAuthScope()	The OAuth scope.
String	getTokenProviderUrl()	The token endpoint URL of the identity provider.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTokenProviderUrl

@Stability(Stable)
@NotNull
String getTokenProviderUrl()

The token endpoint URL of the identity provider.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-oauthparameters.html#cfn-quicksight-datasource-oauthparameters-tokenproviderurl

getIdentityProviderResourceUri

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

The resource uri of the identity provider.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-oauthparameters.html#cfn-quicksight-datasource-oauthparameters-identityproviderresourceuri

getIdentityProviderVpcConnectionProperties

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

VPC connection properties.

.

Returns union: either IResolvable or CfnDataSource.VpcConnectionPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-oauthparameters.html#cfn-quicksight-datasource-oauthparameters-identityprovidervpcconnectionproperties

getOAuthScope

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

The OAuth scope.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-oauthparameters.html#cfn-quicksight-datasource-oauthparameters-oauthscope

builder

@Stability(Stable)
static CfnDataSource.OAuthParametersProperty.Builder builder()

Returns:

a CfnDataSource.OAuthParametersProperty.Builder of CfnDataSource.OAuthParametersProperty