Package software.amazon.awscdk.services.quicksight

Class CfnDataSource.Builder

java.lang.Object
software.amazon.awscdk.services.quicksight.CfnDataSource.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDataSource>
Enclosing class:
CfnDataSource
@Stability(Stable) public static final class CfnDataSource.Builder extends Object implements software.amazon.jsii.Builder<CfnDataSource>
A fluent builder for CfnDataSource.

  • Method Details

    • create

      @Stability(Stable) public static CfnDataSource.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnDataSource.Builder.

    • alternateDataSourceParameters

      @Stability(Stable) public CfnDataSource.Builder alternateDataSourceParameters(IResolvable alternateDataSourceParameters)
      A set of alternate data source parameters that you want to share for the credentials stored with this data source.

      The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.

      Parameters:
      alternateDataSourceParameters - A set of alternate data source parameters that you want to share for the credentials stored with this data source. This parameter is required.
      Returns:
      this

    • alternateDataSourceParameters

      @Stability(Stable) public CfnDataSource.Builder alternateDataSourceParameters(List<? extends Object> alternateDataSourceParameters)
      A set of alternate data source parameters that you want to share for the credentials stored with this data source.

      The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.

      Parameters:
      alternateDataSourceParameters - A set of alternate data source parameters that you want to share for the credentials stored with this data source. This parameter is required.
      Returns:
      this

    • awsAccountId

      @Stability(Stable) public CfnDataSource.Builder awsAccountId(String awsAccountId)
      The AWS account ID.

      Parameters:
      awsAccountId - The AWS account ID. This parameter is required.
      Returns:
      this

    • credentials

      @Stability(Stable) public CfnDataSource.Builder credentials(IResolvable credentials)
      The credentials Amazon QuickSight that uses to connect to your underlying source.

      Currently, only credentials based on user name and password are supported.

      Parameters:
      credentials - The credentials Amazon QuickSight that uses to connect to your underlying source. This parameter is required.
      Returns:
      this

    • credentials

      @Stability(Stable) public CfnDataSource.Builder credentials(CfnDataSource.DataSourceCredentialsProperty credentials)
      The credentials Amazon QuickSight that uses to connect to your underlying source.

      Currently, only credentials based on user name and password are supported.

      Parameters:
      credentials - The credentials Amazon QuickSight that uses to connect to your underlying source. This parameter is required.
      Returns:
      this

    • dataSourceId

      @Stability(Stable) public CfnDataSource.Builder dataSourceId(String dataSourceId)
      An ID for the data source.

      This ID is unique per AWS Region for each AWS account.

      Parameters:
      dataSourceId - An ID for the data source. This parameter is required.
      Returns:
      this

    • dataSourceParameters

      @Stability(Stable) public CfnDataSource.Builder dataSourceParameters(IResolvable dataSourceParameters)
      The parameters that Amazon QuickSight uses to connect to your underlying source.

      Parameters:
      dataSourceParameters - The parameters that Amazon QuickSight uses to connect to your underlying source. This parameter is required.
      Returns:
      this

    • dataSourceParameters

      @Stability(Stable) public CfnDataSource.Builder dataSourceParameters(CfnDataSource.DataSourceParametersProperty dataSourceParameters)
      The parameters that Amazon QuickSight uses to connect to your underlying source.

      Parameters:
      dataSourceParameters - The parameters that Amazon QuickSight uses to connect to your underlying source. This parameter is required.
      Returns:
      this

    • errorInfo

      @Stability(Stable) public CfnDataSource.Builder errorInfo(IResolvable errorInfo)
      Error information from the last update or the creation of the data source.

      Parameters:
      errorInfo - Error information from the last update or the creation of the data source. This parameter is required.
      Returns:
      this

    • errorInfo

      @Stability(Stable) public CfnDataSource.Builder errorInfo(CfnDataSource.DataSourceErrorInfoProperty errorInfo)
      Error information from the last update or the creation of the data source.

      Parameters:
      errorInfo - Error information from the last update or the creation of the data source. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public CfnDataSource.Builder name(String name)
      A display name for the data source.

      Parameters:
      name - A display name for the data source. This parameter is required.
      Returns:
      this

    • permissions

      @Stability(Stable) public CfnDataSource.Builder permissions(IResolvable permissions)
      A list of resource permissions on the data source.

      Parameters:
      permissions - A list of resource permissions on the data source. This parameter is required.
      Returns:
      this

    • permissions

      @Stability(Stable) public CfnDataSource.Builder permissions(List<? extends Object> permissions)
      A list of resource permissions on the data source.

      Parameters:
      permissions - A list of resource permissions on the data source. This parameter is required.
      Returns:
      this

    • sslProperties

      @Stability(Stable) public CfnDataSource.Builder sslProperties(IResolvable sslProperties)
      Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

      Parameters:
      sslProperties - Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source. This parameter is required.
      Returns:
      this

    • sslProperties

      @Stability(Stable) public CfnDataSource.Builder sslProperties(CfnDataSource.SslPropertiesProperty sslProperties)
      Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

      Parameters:
      sslProperties - Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnDataSource.Builder tags(List<? extends CfnTag> tags)
      Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

      Parameters:
      tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the data source. This parameter is required.
      Returns:
      this

    • type

      @Stability(Stable) public CfnDataSource.Builder type(String type)
      The type of the data source. To return a list of all data sources, use ListDataSources .

      Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

      Parameters:
      type - The type of the data source. To return a list of all data sources, use ListDataSources . This parameter is required.
      Returns:
      this

    • vpcConnectionProperties

      @Stability(Stable) public CfnDataSource.Builder vpcConnectionProperties(IResolvable vpcConnectionProperties)
      Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

      Parameters:
      vpcConnectionProperties - Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source. This parameter is required.
      Returns:
      this

    • vpcConnectionProperties

      @Stability(Stable) public CfnDataSource.Builder vpcConnectionProperties(CfnDataSource.VpcConnectionPropertiesProperty vpcConnectionProperties)
      Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

      Parameters:
      vpcConnectionProperties - Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnDataSource build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnDataSource>
      Returns:
      a newly built instance of CfnDataSource.