Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.QuickSight.Types.DataSource

Description

Synopsis

data DataSource = DataSource' {
- alternateDataSourceParameters :: Maybe (NonEmpty DataSourceParameters)
- arn :: Maybe Text
- createdTime :: Maybe POSIX
- dataSourceId :: Maybe Text
- dataSourceParameters :: Maybe DataSourceParameters
- errorInfo :: Maybe DataSourceErrorInfo
- lastUpdatedTime :: Maybe POSIX
- name :: Maybe Text
- secretArn :: Maybe Text
- sslProperties :: Maybe SslProperties
- status :: Maybe ResourceStatus
- type' :: Maybe DataSourceType
- vpcConnectionProperties :: Maybe VpcConnectionProperties
}
newDataSource :: DataSource
dataSource_alternateDataSourceParameters :: Lens' DataSource (Maybe (NonEmpty DataSourceParameters))
dataSource_arn :: Lens' DataSource (Maybe Text)
dataSource_createdTime :: Lens' DataSource (Maybe UTCTime)
dataSource_dataSourceId :: Lens' DataSource (Maybe Text)
dataSource_dataSourceParameters :: Lens' DataSource (Maybe DataSourceParameters)
dataSource_errorInfo :: Lens' DataSource (Maybe DataSourceErrorInfo)
dataSource_lastUpdatedTime :: Lens' DataSource (Maybe UTCTime)
dataSource_name :: Lens' DataSource (Maybe Text)
dataSource_secretArn :: Lens' DataSource (Maybe Text)
dataSource_sslProperties :: Lens' DataSource (Maybe SslProperties)
dataSource_status :: Lens' DataSource (Maybe ResourceStatus)
dataSource_type :: Lens' DataSource (Maybe DataSourceType)
dataSource_vpcConnectionProperties :: Lens' DataSource (Maybe VpcConnectionProperties)

Documentation

data DataSource Source #

The structure of a data source.

See: newDataSource smart constructor.

Constructors

DataSource'

Fields

alternateDataSourceParameters :: Maybe (NonEmpty DataSourceParameters)
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.
arn :: Maybe Text
The Amazon Resource Name (ARN) of the data source.
createdTime :: Maybe POSIX
The time that this data source was created.
dataSourceId :: Maybe Text
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
dataSourceParameters :: Maybe DataSourceParameters
The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
errorInfo :: Maybe DataSourceErrorInfo
Error information from the last update or the creation of the data source.
lastUpdatedTime :: Maybe POSIX
The last time that this data source was updated.
name :: Maybe Text
A display name for the data source.
secretArn :: Maybe Text
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
sslProperties :: Maybe SslProperties
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
status :: Maybe ResourceStatus
The HTTP status of the request.
type' :: Maybe DataSourceType
The type of the data source. This type indicates which database engine the data source connects to.
vpcConnectionProperties :: Maybe VpcConnectionProperties
The VPC connection information. You need to use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

Instances

Instances details

FromJSON DataSource Source #
Instance details Defined in Amazonka.QuickSight.Types.DataSource Methods parseJSON :: Value -> Parser DataSource # parseJSONList :: Value -> Parser [DataSource] #
Generic DataSource Source #
Instance details Defined in Amazonka.QuickSight.Types.DataSource Associated Types type Rep DataSource :: Type -> Type # Methods from :: DataSource -> Rep DataSource x # to :: Rep DataSource x -> DataSource #
Read DataSource Source #
Instance details Defined in Amazonka.QuickSight.Types.DataSource Methods readsPrec :: Int -> ReadS DataSource # readList :: ReadS [DataSource] # readPrec :: ReadPrec DataSource # readListPrec :: ReadPrec [DataSource] #
Show DataSource Source #
Instance details Defined in Amazonka.QuickSight.Types.DataSource Methods showsPrec :: Int -> DataSource -> ShowS # show :: DataSource -> String # showList :: [DataSource] -> ShowS #
NFData DataSource Source #
Instance details Defined in Amazonka.QuickSight.Types.DataSource Methods rnf :: DataSource -> () #
Eq DataSource Source #
Instance details Defined in Amazonka.QuickSight.Types.DataSource Methods (==) :: DataSource -> DataSource -> Bool # (/=) :: DataSource -> DataSource -> Bool #
Hashable DataSource Source #
Instance details Defined in Amazonka.QuickSight.Types.DataSource Methods hashWithSalt :: Int -> DataSource -> Int # hash :: DataSource -> Int #
type Rep DataSource Source #
Instance details Defined in Amazonka.QuickSight.Types.DataSource type Rep DataSource = D1 ('MetaData "DataSource" "Amazonka.QuickSight.Types.DataSource" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "DataSource'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "alternateDataSourceParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceParameters))) :: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "createdTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "dataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "dataSourceParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceParameters)) :: S1 ('MetaSel ('Just "errorInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceErrorInfo))))) :: ((S1 ('MetaSel ('Just "lastUpdatedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "sslProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SslProperties)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceStatus))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceType)) :: S1 ('MetaSel ('Just "vpcConnectionProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConnectionProperties)))))))

newDataSource :: DataSource Source #

Create a value of DataSource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:alternateDataSourceParameters:DataSource', dataSource_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.

$sel:arn:DataSource', dataSource_arn - The Amazon Resource Name (ARN) of the data source.

$sel:createdTime:DataSource', dataSource_createdTime - The time that this data source was created.

$sel:dataSourceId:DataSource', dataSource_dataSourceId - The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

$sel:dataSourceParameters:DataSource', dataSource_dataSourceParameters - The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

$sel:errorInfo:DataSource', dataSource_errorInfo - Error information from the last update or the creation of the data source.

$sel:lastUpdatedTime:DataSource', dataSource_lastUpdatedTime - The last time that this data source was updated.

$sel:name:DataSource', dataSource_name - A display name for the data source.

$sel:secretArn:DataSource', dataSource_secretArn - The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

$sel:sslProperties:DataSource', dataSource_sslProperties - Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

$sel:status:DataSource', dataSource_status - The HTTP status of the request.

DataSource, dataSource_type - The type of the data source. This type indicates which database engine the data source connects to.

$sel:vpcConnectionProperties:DataSource', dataSource_vpcConnectionProperties - The VPC connection information. You need to use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

dataSource_alternateDataSourceParameters :: Lens' DataSource (Maybe (NonEmpty DataSourceParameters)) Source #

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.

dataSource_arn :: Lens' DataSource (Maybe Text) Source #

The Amazon Resource Name (ARN) of the data source.

dataSource_createdTime :: Lens' DataSource (Maybe UTCTime) Source #

The time that this data source was created.

dataSource_dataSourceId :: Lens' DataSource (Maybe Text) Source #

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

dataSource_dataSourceParameters :: Lens' DataSource (Maybe DataSourceParameters) Source #

The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

dataSource_errorInfo :: Lens' DataSource (Maybe DataSourceErrorInfo) Source #

Error information from the last update or the creation of the data source.

dataSource_lastUpdatedTime :: Lens' DataSource (Maybe UTCTime) Source #

The last time that this data source was updated.

dataSource_name :: Lens' DataSource (Maybe Text) Source #

A display name for the data source.

dataSource_secretArn :: Lens' DataSource (Maybe Text) Source #

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

dataSource_sslProperties :: Lens' DataSource (Maybe SslProperties) Source #

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

dataSource_status :: Lens' DataSource (Maybe ResourceStatus) Source #

The HTTP status of the request.

dataSource_type :: Lens' DataSource (Maybe DataSourceType) Source #

The type of the data source. This type indicates which database engine the data source connects to.

dataSource_vpcConnectionProperties :: Lens' DataSource (Maybe VpcConnectionProperties) Source #

The VPC connection information. You need to use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.