Package software.amazon.awscdk.cfnpropertymixins.services.quicksight

Interface CfnDataSourcePropsMixin.OAuthParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSourcePropsMixin.OAuthParametersProperty.Jsii$Proxy

Enclosing class:

CfnDataSourcePropsMixin

@Stability(Stable)
public static interface CfnDataSourcePropsMixin.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.cfnpropertymixins.services.quicksight.*;
 OAuthParametersProperty oAuthParametersProperty = OAuthParametersProperty.builder()
         .identityProviderResourceUri("identityProviderResourceUri")
         .identityProviderVpcConnectionProperties(VpcConnectionPropertiesProperty.builder()
                 .vpcConnectionArn("vpcConnectionArn")
                 .build())
         .oAuthScope("oAuthScope")
         .tokenProviderUrl("tokenProviderUrl")
         .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	CfnDataSourcePropsMixin.OAuthParametersProperty.Builder	A builder for CfnDataSourcePropsMixin.OAuthParametersProperty
static final class	CfnDataSourcePropsMixin.OAuthParametersProperty.Jsii$Proxy	An implementation for CfnDataSourcePropsMixin.OAuthParametersProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSourcePropsMixin.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.
default String	getTokenProviderUrl()	The token endpoint URL of the identity provider.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

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 CfnDataSourcePropsMixin.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

getTokenProviderUrl

@Stability(Stable)
@Nullable
default 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

builder

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

Returns:

a CfnDataSourcePropsMixin.OAuthParametersProperty.Builder of CfnDataSourcePropsMixin.OAuthParametersProperty