Documentation
¶
Index ¶
- type AmazonElasticsearchParameters
- type AmazonOpenSearchParameters
- type AthenaParameters
- type AuroraParameters
- type AuroraPostgreSqlParameters
- type AwsIotAnalyticsParameters
- type CredentialPair
- type DataSourceCredentials
- type DataSourceErrorInfo
- type DataSourceParameters
- type DatabricksParameters
- type ManifestFileLocation
- type MariaDbParameters
- type MySqlParameters
- type OracleParameters
- type PostgreSqlParameters
- type PrestoParameters
- type RdsParameters
- type RedshiftParameters
- type Resource
- type ResourcePermission
- type S3Parameters
- type SnowflakeParameters
- type SparkParameters
- type SqlServerParameters
- type SslProperties
- type Tag
- type TeradataParameters
- type VpcConnectionProperties
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AmazonElasticsearchParameters ¶
type AmazonElasticsearchParameters struct { // <p>The Amazon Elasticsearch Service domain.</p> Domain string `json:"Domain"` }
AmazonElasticsearchParameters <p>Amazon Elasticsearch Service parameters.</p>
func (*AmazonElasticsearchParameters) MarshalJSON ¶
func (strct *AmazonElasticsearchParameters) MarshalJSON() ([]byte, error)
func (*AmazonElasticsearchParameters) UnmarshalJSON ¶
func (strct *AmazonElasticsearchParameters) UnmarshalJSON(b []byte) error
type AmazonOpenSearchParameters ¶
type AmazonOpenSearchParameters struct { // <p>The Amazon OpenSearch Service domain.</p> Domain string `json:"Domain"` }
AmazonOpenSearchParameters <p>Amazon OpenSearch Service parameters.</p>
func (*AmazonOpenSearchParameters) MarshalJSON ¶
func (strct *AmazonOpenSearchParameters) MarshalJSON() ([]byte, error)
func (*AmazonOpenSearchParameters) UnmarshalJSON ¶
func (strct *AmazonOpenSearchParameters) UnmarshalJSON(b []byte) error
type AthenaParameters ¶
type AthenaParameters struct { // <p>The workgroup that Amazon Athena uses.</p> WorkGroup string `json:"WorkGroup,omitempty"` }
AthenaParameters <p>Amazon Athena parameters.</p>
type AuroraParameters ¶
type AuroraParameters struct { // <p>Database.</p> Database string `json:"Database"` // <p>Host.</p> Host string `json:"Host"` // <p>Port.</p> Port float64 `json:"Port"` }
AuroraParameters <p>Amazon Aurora parameters.</p>
func (*AuroraParameters) MarshalJSON ¶
func (strct *AuroraParameters) MarshalJSON() ([]byte, error)
func (*AuroraParameters) UnmarshalJSON ¶
func (strct *AuroraParameters) UnmarshalJSON(b []byte) error
type AuroraPostgreSqlParameters ¶
type AuroraPostgreSqlParameters struct { // <p>Database.</p> Database string `json:"Database"` // <p>Host.</p> Host string `json:"Host"` // <p>Port.</p> Port float64 `json:"Port"` }
AuroraPostgreSqlParameters <p>Amazon Aurora with PostgreSQL compatibility parameters.</p>
func (*AuroraPostgreSqlParameters) MarshalJSON ¶
func (strct *AuroraPostgreSqlParameters) MarshalJSON() ([]byte, error)
func (*AuroraPostgreSqlParameters) UnmarshalJSON ¶
func (strct *AuroraPostgreSqlParameters) UnmarshalJSON(b []byte) error
type AwsIotAnalyticsParameters ¶
type AwsIotAnalyticsParameters struct { // <p>Dataset name.</p> DataSetName string `json:"DataSetName"` }
AwsIotAnalyticsParameters <p>AWS IoT Analytics parameters.</p>
func (*AwsIotAnalyticsParameters) MarshalJSON ¶
func (strct *AwsIotAnalyticsParameters) MarshalJSON() ([]byte, error)
func (*AwsIotAnalyticsParameters) UnmarshalJSON ¶
func (strct *AwsIotAnalyticsParameters) UnmarshalJSON(b []byte) error
type CredentialPair ¶
type CredentialPair struct { // <p>A set of alternate data source parameters that you want to share for these // credentials. 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 <code>DataSourceParameters</code> structure that's in the request with the // structures in the <code>AlternateDataSourceParameters</code> allow list. If the // structures are an exact match, the request is allowed to use the new data source with // the existing credentials. If the <code>AlternateDataSourceParameters</code> list is // null, the <code>DataSourceParameters</code> originally used with these // <code>Credentials</code> is automatically allowed.</p> AlternateDataSourceParameters []*DataSourceParameters `json:"AlternateDataSourceParameters,omitempty"` // <p>Password.</p> Password string `json:"Password"` // <p>User name.</p> Username string `json:"Username"` }
CredentialPair <p>The combination of user name and password that are used as credentials.</p>
func (*CredentialPair) MarshalJSON ¶
func (strct *CredentialPair) MarshalJSON() ([]byte, error)
func (*CredentialPair) UnmarshalJSON ¶
func (strct *CredentialPair) UnmarshalJSON(b []byte) error
type DataSourceCredentials ¶
type DataSourceCredentials struct { // <p>The Amazon Resource Name (ARN) of a data source that has the credential pair that you // want to use. When <code>CopySourceArn</code> is not null, the credential pair from the // data source in the ARN is used as the credentials for the // <code>DataSourceCredentials</code> structure.</p> CopySourceArn string `json:"CopySourceArn,omitempty"` CredentialPair *CredentialPair `json:"CredentialPair,omitempty"` // <p>The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.</p> SecretArn string `json:"SecretArn,omitempty"` }
DataSourceCredentials <p>Data source credentials. This is a variant type structure. For this structure to be
valid, only one of the attributes can be non-null.</p>
type DataSourceErrorInfo ¶
type DataSourceErrorInfo struct { // <p>Error message.</p> Message string `json:"Message,omitempty"` Type string `json:"Type,omitempty"` }
DataSourceErrorInfo <p>Error information for the data source creation or update.</p>
type DataSourceParameters ¶
type DataSourceParameters struct { AmazonElasticsearchParameters *AmazonElasticsearchParameters `json:"AmazonElasticsearchParameters,omitempty"` AmazonOpenSearchParameters *AmazonOpenSearchParameters `json:"AmazonOpenSearchParameters,omitempty"` AthenaParameters *AthenaParameters `json:"AthenaParameters,omitempty"` AuroraParameters *AuroraParameters `json:"AuroraParameters,omitempty"` AuroraPostgreSqlParameters *AuroraPostgreSqlParameters `json:"AuroraPostgreSqlParameters,omitempty"` DatabricksParameters *DatabricksParameters `json:"DatabricksParameters,omitempty"` MariaDbParameters *MariaDbParameters `json:"MariaDbParameters,omitempty"` MySqlParameters *MySqlParameters `json:"MySqlParameters,omitempty"` OracleParameters *OracleParameters `json:"OracleParameters,omitempty"` PostgreSqlParameters *PostgreSqlParameters `json:"PostgreSqlParameters,omitempty"` PrestoParameters *PrestoParameters `json:"PrestoParameters,omitempty"` RdsParameters *RdsParameters `json:"RdsParameters,omitempty"` RedshiftParameters *RedshiftParameters `json:"RedshiftParameters,omitempty"` S3Parameters *S3Parameters `json:"S3Parameters,omitempty"` SnowflakeParameters *SnowflakeParameters `json:"SnowflakeParameters,omitempty"` SparkParameters *SparkParameters `json:"SparkParameters,omitempty"` SqlServerParameters *SqlServerParameters `json:"SqlServerParameters,omitempty"` TeradataParameters *TeradataParameters `json:"TeradataParameters,omitempty"` }
DataSourceParameters <p>The parameters that Amazon QuickSight uses to connect to your underlying data source.
This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.</p>
type DatabricksParameters ¶
type DatabricksParameters struct { // <p>Host.</p> Host string `json:"Host"` // <p>Port.</p> Port float64 `json:"Port"` // <p>The HTTP Path of the Databricks data source.</p> SqlEndpointPath string `json:"SqlEndpointPath"` }
DatabricksParameters <p>Databricks parameters.</p>
func (*DatabricksParameters) MarshalJSON ¶
func (strct *DatabricksParameters) MarshalJSON() ([]byte, error)
func (*DatabricksParameters) UnmarshalJSON ¶
func (strct *DatabricksParameters) UnmarshalJSON(b []byte) error
type ManifestFileLocation ¶
type ManifestFileLocation struct { // <p>Amazon S3 bucket.</p> Bucket string `json:"Bucket"` // <p>Amazon S3 key that identifies an object.</p> Key string `json:"Key"` }
ManifestFileLocation <p>Amazon S3 manifest file location.</p>
func (*ManifestFileLocation) MarshalJSON ¶
func (strct *ManifestFileLocation) MarshalJSON() ([]byte, error)
func (*ManifestFileLocation) UnmarshalJSON ¶
func (strct *ManifestFileLocation) UnmarshalJSON(b []byte) error
type MariaDbParameters ¶
type MariaDbParameters struct { // <p>Database.</p> Database string `json:"Database"` // <p>Host.</p> Host string `json:"Host"` // <p>Port.</p> Port float64 `json:"Port"` }
MariaDbParameters <p>MariaDB parameters.</p>
func (*MariaDbParameters) MarshalJSON ¶
func (strct *MariaDbParameters) MarshalJSON() ([]byte, error)
func (*MariaDbParameters) UnmarshalJSON ¶
func (strct *MariaDbParameters) UnmarshalJSON(b []byte) error
type MySqlParameters ¶
type MySqlParameters struct { // <p>Database.</p> Database string `json:"Database"` // <p>Host.</p> Host string `json:"Host"` // <p>Port.</p> Port float64 `json:"Port"` }
MySqlParameters <p>MySQL parameters.</p>
func (*MySqlParameters) MarshalJSON ¶
func (strct *MySqlParameters) MarshalJSON() ([]byte, error)
func (*MySqlParameters) UnmarshalJSON ¶
func (strct *MySqlParameters) UnmarshalJSON(b []byte) error
type OracleParameters ¶
type OracleParameters struct { Database string `json:"Database"` Host string `json:"Host"` Port float64 `json:"Port"` }
OracleParameters
func (*OracleParameters) MarshalJSON ¶
func (strct *OracleParameters) MarshalJSON() ([]byte, error)
func (*OracleParameters) UnmarshalJSON ¶
func (strct *OracleParameters) UnmarshalJSON(b []byte) error
type PostgreSqlParameters ¶
type PostgreSqlParameters struct { // <p>Database.</p> Database string `json:"Database"` // <p>Host.</p> Host string `json:"Host"` // <p>Port.</p> Port float64 `json:"Port"` }
PostgreSqlParameters <p>PostgreSQL parameters.</p>
func (*PostgreSqlParameters) MarshalJSON ¶
func (strct *PostgreSqlParameters) MarshalJSON() ([]byte, error)
func (*PostgreSqlParameters) UnmarshalJSON ¶
func (strct *PostgreSqlParameters) UnmarshalJSON(b []byte) error
type PrestoParameters ¶
type PrestoParameters struct { // <p>Catalog.</p> Catalog string `json:"Catalog"` // <p>Host.</p> Host string `json:"Host"` // <p>Port.</p> Port float64 `json:"Port"` }
PrestoParameters <p>Presto parameters.</p>
func (*PrestoParameters) MarshalJSON ¶
func (strct *PrestoParameters) MarshalJSON() ([]byte, error)
func (*PrestoParameters) UnmarshalJSON ¶
func (strct *PrestoParameters) UnmarshalJSON(b []byte) error
type RdsParameters ¶
type RdsParameters struct { // <p>Database.</p> Database string `json:"Database"` // <p>Instance ID.</p> InstanceId string `json:"InstanceId"` }
RdsParameters <p>Amazon RDS parameters.</p>
func (*RdsParameters) MarshalJSON ¶
func (strct *RdsParameters) MarshalJSON() ([]byte, error)
func (*RdsParameters) UnmarshalJSON ¶
func (strct *RdsParameters) UnmarshalJSON(b []byte) error
type RedshiftParameters ¶
type RedshiftParameters struct { // <p>Cluster ID. This field can be blank if the <code>Host</code> and <code>Port</code> are // provided.</p> ClusterId string `json:"ClusterId,omitempty"` // <p>Database.</p> Database string `json:"Database"` // <p>Host. This field can be blank if <code>ClusterId</code> is provided.</p> Host string `json:"Host,omitempty"` // <p>Port. This field can be blank if the <code>ClusterId</code> is provided.</p> Port float64 `json:"Port,omitempty"` }
RedshiftParameters <p>Amazon Redshift parameters. The <code>ClusterId</code> field can be blank if
<code>Host</code> and <code>Port</code> are both set. The <code>Host</code> and <code>Port</code> fields can be blank if the <code>ClusterId</code> field is set.</p>
func (*RedshiftParameters) MarshalJSON ¶
func (strct *RedshiftParameters) MarshalJSON() ([]byte, error)
func (*RedshiftParameters) UnmarshalJSON ¶
func (strct *RedshiftParameters) UnmarshalJSON(b []byte) error
type Resource ¶
type Resource struct { // <p>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 <code>DataSourceParameters</code> structure that's in the request // with the structures in the <code>AlternateDataSourceParameters</code> allow list. If the // structures are an exact match, the request is allowed to use the credentials from this // existing data source. If the <code>AlternateDataSourceParameters</code> list is null, // the <code>Credentials</code> originally used with this <code>DataSourceParameters</code> // are automatically allowed.</p> AlternateDataSourceParameters []*DataSourceParameters `json:"AlternateDataSourceParameters,omitempty"` // <p>The Amazon Resource Name (ARN) of the data source.</p> Arn string `json:"Arn,omitempty"` AwsAccountId string `json:"AwsAccountId,omitempty"` // <p>The time that this data source was created.</p> CreatedTime string `json:"CreatedTime,omitempty"` Credentials *DataSourceCredentials `json:"Credentials,omitempty"` DataSourceId string `json:"DataSourceId,omitempty"` DataSourceParameters *DataSourceParameters `json:"DataSourceParameters,omitempty"` ErrorInfo *DataSourceErrorInfo `json:"ErrorInfo,omitempty"` // <p>The last time that this data source was updated.</p> LastUpdatedTime string `json:"LastUpdatedTime,omitempty"` // <p>A display name for the data source.</p> Name string `json:"Name,omitempty"` // <p>A list of resource permissions on the data source.</p> Permissions []*ResourcePermission `json:"Permissions,omitempty"` SslProperties *SslProperties `json:"SslProperties,omitempty"` Status string `json:"Status,omitempty"` // <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.</p> Tags []*Tag `json:"Tags,omitempty"` Type string `json:"Type,omitempty"` VpcConnectionProperties *VpcConnectionProperties `json:"VpcConnectionProperties,omitempty"` }
Resource Definition of the AWS::QuickSight::DataSource Resource Type.
func (*Resource) MarshalJSON ¶
func (*Resource) UnmarshalJSON ¶
type ResourcePermission ¶
type ResourcePermission struct { // <p>The IAM action to grant or revoke permissions on.</p> Actions []string `json:"Actions"` // <p>The Amazon Resource Name (ARN) of the principal. This can be one of the // following:</p> // <ul> // <li> // <p>The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)</p> // </li> // <li> // <p>The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)</p> // </li> // <li> // <p>The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight // ARN. Use this option only to share resources (templates) across AWS accounts. // (This is less common.) </p> // </li> // </ul> Principal string `json:"Principal"` }
ResourcePermission <p>Permission for the resource.</p>
func (*ResourcePermission) MarshalJSON ¶
func (strct *ResourcePermission) MarshalJSON() ([]byte, error)
func (*ResourcePermission) UnmarshalJSON ¶
func (strct *ResourcePermission) UnmarshalJSON(b []byte) error
type S3Parameters ¶
type S3Parameters struct {
ManifestFileLocation *ManifestFileLocation `json:"ManifestFileLocation"`
}
S3Parameters <p>S3 parameters.</p>
func (*S3Parameters) MarshalJSON ¶
func (strct *S3Parameters) MarshalJSON() ([]byte, error)
func (*S3Parameters) UnmarshalJSON ¶
func (strct *S3Parameters) UnmarshalJSON(b []byte) error
type SnowflakeParameters ¶
type SnowflakeParameters struct { // <p>Database.</p> Database string `json:"Database"` // <p>Host.</p> Host string `json:"Host"` // <p>Warehouse.</p> Warehouse string `json:"Warehouse"` }
SnowflakeParameters <p>Snowflake parameters.</p>
func (*SnowflakeParameters) MarshalJSON ¶
func (strct *SnowflakeParameters) MarshalJSON() ([]byte, error)
func (*SnowflakeParameters) UnmarshalJSON ¶
func (strct *SnowflakeParameters) UnmarshalJSON(b []byte) error
type SparkParameters ¶
type SparkParameters struct { // <p>Host.</p> Host string `json:"Host"` // <p>Port.</p> Port float64 `json:"Port"` }
SparkParameters <p>Spark parameters.</p>
func (*SparkParameters) MarshalJSON ¶
func (strct *SparkParameters) MarshalJSON() ([]byte, error)
func (*SparkParameters) UnmarshalJSON ¶
func (strct *SparkParameters) UnmarshalJSON(b []byte) error
type SqlServerParameters ¶
type SqlServerParameters struct { // <p>Database.</p> Database string `json:"Database"` // <p>Host.</p> Host string `json:"Host"` // <p>Port.</p> Port float64 `json:"Port"` }
SqlServerParameters <p>SQL Server parameters.</p>
func (*SqlServerParameters) MarshalJSON ¶
func (strct *SqlServerParameters) MarshalJSON() ([]byte, error)
func (*SqlServerParameters) UnmarshalJSON ¶
func (strct *SqlServerParameters) UnmarshalJSON(b []byte) error
type SslProperties ¶
type SslProperties struct { // <p>A Boolean option to control whether SSL should be disabled.</p> DisableSsl bool `json:"DisableSsl,omitempty"` }
SslProperties <p>Secure Socket Layer (SSL) properties that apply when QuickSight connects to your
underlying data source.</p>
type Tag ¶
type Tag struct { // <p>Tag key.</p> Key string `json:"Key"` // <p>Tag value.</p> Value string `json:"Value"` }
Tag <p>The key or keys of the key-value pairs for the resource tag or tags assigned to the
resource.</p>
func (*Tag) MarshalJSON ¶
func (*Tag) UnmarshalJSON ¶
type TeradataParameters ¶
type TeradataParameters struct { // <p>Database.</p> Database string `json:"Database"` // <p>Host.</p> Host string `json:"Host"` // <p>Port.</p> Port float64 `json:"Port"` }
TeradataParameters <p>Teradata parameters.</p>
func (*TeradataParameters) MarshalJSON ¶
func (strct *TeradataParameters) MarshalJSON() ([]byte, error)
func (*TeradataParameters) UnmarshalJSON ¶
func (strct *TeradataParameters) UnmarshalJSON(b []byte) error
type VpcConnectionProperties ¶
type VpcConnectionProperties struct { // <p>The Amazon Resource Name (ARN) for the VPC connection.</p> VpcConnectionArn string `json:"VpcConnectionArn"` }
VpcConnectionProperties <p>VPC connection properties.</p>
func (*VpcConnectionProperties) MarshalJSON ¶
func (strct *VpcConnectionProperties) MarshalJSON() ([]byte, error)
func (*VpcConnectionProperties) UnmarshalJSON ¶
func (strct *VpcConnectionProperties) UnmarshalJSON(b []byte) error