Class: Aws::QuickSight::Types::CredentialPair
- Inherits:
-
Struct
- Object
- Struct
- Aws::QuickSight::Types::CredentialPair
- Defined in:
- gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb
Overview
When making an API call, you may pass CredentialPair data as a hash:
{
username: "Username", # required
password: "Password", # required
alternate_data_source_parameters: [
{
amazon_elasticsearch_parameters: {
domain: "Domain", # required
},
athena_parameters: {
work_group: "WorkGroup",
},
aurora_parameters: {
host: "Host", # required
port: 1, # required
database: "Database", # required
},
aurora_postgre_sql_parameters: {
host: "Host", # required
port: 1, # required
database: "Database", # required
},
aws_iot_analytics_parameters: {
data_set_name: "DataSetName", # required
},
jira_parameters: {
site_base_url: "SiteBaseUrl", # required
},
maria_db_parameters: {
host: "Host", # required
port: 1, # required
database: "Database", # required
},
my_sql_parameters: {
host: "Host", # required
port: 1, # required
database: "Database", # required
},
oracle_parameters: {
host: "Host", # required
port: 1, # required
database: "Database", # required
},
postgre_sql_parameters: {
host: "Host", # required
port: 1, # required
database: "Database", # required
},
presto_parameters: {
host: "Host", # required
port: 1, # required
catalog: "Catalog", # required
},
rds_parameters: {
instance_id: "InstanceId", # required
database: "Database", # required
},
redshift_parameters: {
host: "Host",
port: 1,
database: "Database", # required
cluster_id: "ClusterId",
},
s3_parameters: {
manifest_file_location: { # required
bucket: "S3Bucket", # required
key: "S3Key", # required
},
},
service_now_parameters: {
site_base_url: "SiteBaseUrl", # required
},
snowflake_parameters: {
host: "Host", # required
database: "Database", # required
warehouse: "Warehouse", # required
},
spark_parameters: {
host: "Host", # required
port: 1, # required
},
sql_server_parameters: {
host: "Host", # required
port: 1, # required
database: "Database", # required
},
teradata_parameters: {
host: "Host", # required
port: 1, # required
database: "Database", # required
},
twitter_parameters: {
query: "Query", # required
max_rows: 1, # required
},
amazon_open_search_parameters: {
domain: "Domain", # required
},
exasol_parameters: {
host: "Host", # required
port: 1, # required
},
},
],
}
The combination of user name and password that are used as credentials.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#alternate_data_source_parameters ⇒ Array<Types::DataSourceParameters>
A set of alternate data source parameters that you want to share for these credentials.
-
#password ⇒ String
Password.
-
#username ⇒ String
User name.
Instance Attribute Details
#alternate_data_source_parameters ⇒ Array<Types::DataSourceParameters>
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
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 new
data source with the existing credentials. If the
AlternateDataSourceParameters
list is null, the
DataSourceParameters
originally used with these Credentials
is
automatically allowed.
3160 3161 3162 3163 3164 3165 3166 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3160 class CredentialPair < Struct.new( :username, :password, :alternate_data_source_parameters) SENSITIVE = [] include Aws::Structure end |
#password ⇒ String
Password.
3160 3161 3162 3163 3164 3165 3166 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3160 class CredentialPair < Struct.new( :username, :password, :alternate_data_source_parameters) SENSITIVE = [] include Aws::Structure end |
#username ⇒ String
User name.
3160 3161 3162 3163 3164 3165 3166 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 3160 class CredentialPair < Struct.new( :username, :password, :alternate_data_source_parameters) SENSITIVE = [] include Aws::Structure end |