Package software.amazon.awscdk.services.quicksight

Class CfnDataSource

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.quicksight.CfnDataSource
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IDataSourceRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-04-14T18:32:01.926Z") @Stability(Stable) public class CfnDataSource extends CfnResource implements IInspectable, IDataSourceRef, ITaggable
Creates a data source.

Example:

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDataSource

      protected CfnDataSource(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDataSource

      protected CfnDataSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDataSource

      @Stability(Stable) public CfnDataSource(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDataSourceProps props)
      Create a new AWS::QuickSight::DataSource.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForDataSource

      @Stability(Stable) @NotNull public static String arnForDataSource(@NotNull IDataSourceRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnDataSource

      @Stability(Stable) @NotNull public static Boolean isCfnDataSource(@NotNull Object x)
      Checks whether the given object is a CfnDataSource.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the dataset.

    • getAttrCreatedTime

      @Stability(Stable) @NotNull public String getAttrCreatedTime()
      The time that this data source was created.

    • getAttrLastUpdatedTime

      @Stability(Stable) @NotNull public String getAttrLastUpdatedTime()
      The last time that this data source was updated.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The HTTP status of the request.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDataSourceRef

      @Stability(Stable) @NotNull public DataSourceReference getDataSourceRef()
      A reference to a DataSource resource.
      Specified by:
      getDataSourceRef in interface IDataSourceRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

      @Stability(Stable) @NotNull public String getName()
      A display name for the data source.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      A display name for the data source.

    • getType

      @Stability(Stable) @NotNull public String getType()
      The type of the data source.

      To return a list of all data sources, use ListDataSources .

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The type of the data source.

      To return a list of all data sources, use ListDataSources .

    • getAlternateDataSourceParameters

      @Stability(Stable) @Nullable public Object getAlternateDataSourceParameters()
      A set of alternate data source parameters that you want to share for the credentials stored with this data source.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataSource.DataSourceParametersProperty>

    • setAlternateDataSourceParameters

      @Stability(Stable) public void setAlternateDataSourceParameters(@Nullable IResolvable value)
      A set of alternate data source parameters that you want to share for the credentials stored with this data source.

    • setAlternateDataSourceParameters

      @Stability(Stable) public void setAlternateDataSourceParameters(@Nullable List<Object> value)
      A set of alternate data source parameters that you want to share for the credentials stored with this data source.

    • getAwsAccountId

      @Stability(Stable) @Nullable public String getAwsAccountId()
      The AWS account ID.

    • setAwsAccountId

      @Stability(Stable) public void setAwsAccountId(@Nullable String value)
      The AWS account ID.

    • getCredentials

      @Stability(Stable) @Nullable public Object getCredentials()
      The credentials Amazon Quick Sight that uses to connect to your underlying source.

      Returns union: either IResolvable or CfnDataSource.DataSourceCredentialsProperty

    • setCredentials

      @Stability(Stable) public void setCredentials(@Nullable IResolvable value)
      The credentials Amazon Quick Sight that uses to connect to your underlying source.

    • setCredentials

      @Stability(Stable) public void setCredentials(@Nullable CfnDataSource.DataSourceCredentialsProperty value)
      The credentials Amazon Quick Sight that uses to connect to your underlying source.

    • getDataSourceId

      @Stability(Stable) @Nullable public String getDataSourceId()
      An ID for the data source.

    • setDataSourceId

      @Stability(Stable) public void setDataSourceId(@Nullable String value)
      An ID for the data source.

    • getDataSourceParameters

      @Stability(Stable) @Nullable public Object getDataSourceParameters()
      The parameters that Amazon Quick Sight uses to connect to your underlying source.

      Returns union: either IResolvable or CfnDataSource.DataSourceParametersProperty

    • setDataSourceParameters

      @Stability(Stable) public void setDataSourceParameters(@Nullable IResolvable value)
      The parameters that Amazon Quick Sight uses to connect to your underlying source.

    • setDataSourceParameters

      @Stability(Stable) public void setDataSourceParameters(@Nullable CfnDataSource.DataSourceParametersProperty value)
      The parameters that Amazon Quick Sight uses to connect to your underlying source.

    • getErrorInfo

      @Stability(Stable) @Nullable public Object getErrorInfo()
      Error information from the last update or the creation of the data source.

      Returns union: either IResolvable or CfnDataSource.DataSourceErrorInfoProperty

    • setErrorInfo

      @Stability(Stable) public void setErrorInfo(@Nullable IResolvable value)
      Error information from the last update or the creation of the data source.

    • setErrorInfo

      @Stability(Stable) public void setErrorInfo(@Nullable CfnDataSource.DataSourceErrorInfoProperty value)
      Error information from the last update or the creation of the data source.

    • getFolderArns

      @Stability(Stable) @Nullable public List<String> getFolderArns()

    • setFolderArns

      @Stability(Stable) public void setFolderArns(@Nullable List<String> value)

    • getPermissions

      @Stability(Stable) @Nullable public Object getPermissions()
      A list of resource permissions on the data source.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataSource.ResourcePermissionProperty>

    • setPermissions

      @Stability(Stable) public void setPermissions(@Nullable IResolvable value)
      A list of resource permissions on the data source.

    • setPermissions

      @Stability(Stable) public void setPermissions(@Nullable List<Object> value)
      A list of resource permissions on the data source.

    • getSslProperties

      @Stability(Stable) @Nullable public Object getSslProperties()
      Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.

      Returns union: either IResolvable or CfnDataSource.SslPropertiesProperty

    • setSslProperties

      @Stability(Stable) public void setSslProperties(@Nullable IResolvable value)
      Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.

    • setSslProperties

      @Stability(Stable) public void setSslProperties(@Nullable CfnDataSource.SslPropertiesProperty value)
      Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.

    • getTagsRaw

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

    • setTagsRaw

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

    • getVpcConnectionProperties

      @Stability(Stable) @Nullable public Object getVpcConnectionProperties()
      Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.

      Returns union: either IResolvable or CfnDataSource.VpcConnectionPropertiesProperty

    • setVpcConnectionProperties

      @Stability(Stable) public void setVpcConnectionProperties(@Nullable IResolvable value)
      Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.

    • setVpcConnectionProperties

      @Stability(Stable) public void setVpcConnectionProperties(@Nullable CfnDataSource.VpcConnectionPropertiesProperty value)
      Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.