« blib/lib/Paws/Quicksight/CreateDataSetResponse.pm
↑ Summary
blib/lib/Paws/Quicksight/CreateDataSourceResponse.pm »
| 1 | |||
| 2 | package Paws::Quicksight::CreateDataSource; | ||
| 3 | use Moose; | ||
| 4 | has AwsAccountId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'AwsAccountId', required => 1); | ||
| 5 | has Credentials => (is => 'ro', isa => 'Paws::Quicksight::DataSourceCredentials'); | ||
| 6 | has DataSourceId => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has DataSourceParameters => (is => 'ro', isa => 'Paws::Quicksight::DataSourceParameters'); | ||
| 8 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has Permissions => (is => 'ro', isa => 'ArrayRef[Paws::Quicksight::ResourcePermission]'); | ||
| 10 | has SslProperties => (is => 'ro', isa => 'Paws::Quicksight::SslProperties'); | ||
| 11 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Quicksight::Tag]'); | ||
| 12 | has Type => (is => 'ro', isa => 'Str', required => 1); | ||
| 13 | has VpcConnectionProperties => (is => 'ro', isa => 'Paws::Quicksight::VpcConnectionProperties'); | ||
| 14 | |||
| 15 | use MooseX::ClassAttribute; | ||
| 16 | |||
| 17 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDataSource'); | ||
| 18 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/accounts/{AwsAccountId}/data-sources'); | ||
| 19 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 20 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Quicksight::CreateDataSourceResponse'); | ||
| 21 | 1; | ||
| 22 | |||
| 23 | ### main pod documentation begin ### | ||
| 24 | |||
| 25 | =head1 NAME | ||
| 26 | |||
| 27 | Paws::Quicksight::CreateDataSource - Arguments for method CreateDataSource on L<Paws::Quicksight> | ||
| 28 | |||
| 29 | =head1 DESCRIPTION | ||
| 30 | |||
| 31 | This class represents the parameters used for calling the method CreateDataSource on the | ||
| 32 | L<Amazon QuickSight|Paws::Quicksight> service. Use the attributes of this class | ||
| 33 | as arguments to method CreateDataSource. | ||
| 34 | |||
| 35 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDataSource. | ||
| 36 | |||
| 37 | =head1 SYNOPSIS | ||
| 38 | |||
| 39 | my $quicksight = Paws->service('Quicksight'); | ||
| 40 | my $CreateDataSourceResponse = $quicksight->CreateDataSource( | ||
| 41 | AwsAccountId => 'MyAwsAccountId', | ||
| 42 | DataSourceId => 'MyResourceId', | ||
| 43 | Name => 'MyResourceName', | ||
| 44 | Type => 'ADOBE_ANALYTICS', | ||
| 45 | Credentials => { | ||
| 46 | CopySourceArn => 'MyCopySourceArn', # OPTIONAL | ||
| 47 | CredentialPair => { | ||
| 48 | Password => 'MyPassword', # min: 1, max: 1024 | ||
| 49 | Username => 'MyUsername', # min: 1, max: 64 | ||
| 50 | AlternateDataSourceParameters => [ | ||
| 51 | { | ||
| 52 | AmazonElasticsearchParameters => { | ||
| 53 | Domain => 'MyDomain', # min: 1, max: 64 | ||
| 54 | |||
| 55 | }, # OPTIONAL | ||
| 56 | AthenaParameters => { | ||
| 57 | WorkGroup => 'MyWorkGroup', # min: 1, max: 128; OPTIONAL | ||
| 58 | }, # OPTIONAL | ||
| 59 | AuroraParameters => { | ||
| 60 | Database => 'MyDatabase', # min: 1, max: 128 | ||
| 61 | Host => 'MyHost', # min: 1, max: 256 | ||
| 62 | Port => 1, # min: 1, max: 65535 | ||
| 63 | |||
| 64 | }, # OPTIONAL | ||
| 65 | AuroraPostgreSqlParameters => { | ||
| 66 | Database => 'MyDatabase', # min: 1, max: 128 | ||
| 67 | Host => 'MyHost', # min: 1, max: 256 | ||
| 68 | Port => 1, # min: 1, max: 65535 | ||
| 69 | |||
| 70 | }, # OPTIONAL | ||
| 71 | AwsIotAnalyticsParameters => { | ||
| 72 | DataSetName => 'MyDataSetName', # min: 1, max: 128 | ||
| 73 | |||
| 74 | }, # OPTIONAL | ||
| 75 | JiraParameters => { | ||
| 76 | SiteBaseUrl => 'MySiteBaseUrl', # min: 1, max: 1024 | ||
| 77 | |||
| 78 | }, # OPTIONAL | ||
| 79 | MariaDbParameters => { | ||
| 80 | Database => 'MyDatabase', # min: 1, max: 128 | ||
| 81 | Host => 'MyHost', # min: 1, max: 256 | ||
| 82 | Port => 1, # min: 1, max: 65535 | ||
| 83 | |||
| 84 | }, # OPTIONAL | ||
| 85 | MySqlParameters => { | ||
| 86 | Database => 'MyDatabase', # min: 1, max: 128 | ||
| 87 | Host => 'MyHost', # min: 1, max: 256 | ||
| 88 | Port => 1, # min: 1, max: 65535 | ||
| 89 | |||
| 90 | }, # OPTIONAL | ||
| 91 | OracleParameters => { | ||
| 92 | Database => 'MyDatabase', # min: 1, max: 128 | ||
| 93 | Host => 'MyHost', # min: 1, max: 256 | ||
| 94 | Port => 1, # min: 1, max: 65535 | ||
| 95 | |||
| 96 | }, # OPTIONAL | ||
| 97 | PostgreSqlParameters => { | ||
| 98 | Database => 'MyDatabase', # min: 1, max: 128 | ||
| 99 | Host => 'MyHost', # min: 1, max: 256 | ||
| 100 | Port => 1, # min: 1, max: 65535 | ||
| 101 | |||
| 102 | }, # OPTIONAL | ||
| 103 | PrestoParameters => { | ||
| 104 | Catalog => 'MyCatalog', # max: 128 | ||
| 105 | Host => 'MyHost', # min: 1, max: 256 | ||
| 106 | Port => 1, # min: 1, max: 65535 | ||
| 107 | |||
| 108 | }, # OPTIONAL | ||
| 109 | RdsParameters => { | ||
| 110 | Database => 'MyDatabase', # min: 1, max: 128 | ||
| 111 | InstanceId => 'MyInstanceId', # min: 1, max: 64 | ||
| 112 | |||
| 113 | }, # OPTIONAL | ||
| 114 | RedshiftParameters => { | ||
| 115 | Database => 'MyDatabase', # min: 1, max: 128 | ||
| 116 | ClusterId => 'MyClusterId', # min: 1, max: 64; OPTIONAL | ||
| 117 | Host => 'MyHost', # min: 1, max: 256 | ||
| 118 | Port => 1, # max: 65535; OPTIONAL | ||
| 119 | }, # OPTIONAL | ||
| 120 | S3Parameters => { | ||
| 121 | ManifestFileLocation => { | ||
| 122 | Bucket => 'MyS3Bucket', # min: 1, max: 1024 | ||
| 123 | Key => 'MyS3Key', # min: 1, max: 1024 | ||
| 124 | |||
| 125 | }, | ||
| 126 | |||
| 127 | }, # OPTIONAL | ||
| 128 | ServiceNowParameters => { | ||
| 129 | SiteBaseUrl => 'MySiteBaseUrl', # min: 1, max: 1024 | ||
| 130 | |||
| 131 | }, # OPTIONAL | ||
| 132 | SnowflakeParameters => { | ||
| 133 | Database => 'MyDatabase', # min: 1, max: 128 | ||
| 134 | Host => 'MyHost', # min: 1, max: 256 | ||
| 135 | Warehouse => 'MyWarehouse', # max: 128 | ||
| 136 | |||
| 137 | }, # OPTIONAL | ||
| 138 | SparkParameters => { | ||
| 139 | Host => 'MyHost', # min: 1, max: 256 | ||
| 140 | Port => 1, # min: 1, max: 65535 | ||
| 141 | |||
| 142 | }, # OPTIONAL | ||
| 143 | SqlServerParameters => { | ||
| 144 | Database => 'MyDatabase', # min: 1, max: 128 | ||
| 145 | Host => 'MyHost', # min: 1, max: 256 | ||
| 146 | Port => 1, # min: 1, max: 65535 | ||
| 147 | |||
| 148 | }, # OPTIONAL | ||
| 149 | TeradataParameters => { | ||
| 150 | Database => 'MyDatabase', # min: 1, max: 128 | ||
| 151 | Host => 'MyHost', # min: 1, max: 256 | ||
| 152 | Port => 1, # min: 1, max: 65535 | ||
| 153 | |||
| 154 | }, # OPTIONAL | ||
| 155 | TwitterParameters => { | ||
| 156 | MaxRows => 1, # min: 1 | ||
| 157 | Query => 'MyQuery', # min: 1, max: 256 | ||
| 158 | |||
| 159 | }, # OPTIONAL | ||
| 160 | }, | ||
| 161 | ... | ||
| 162 | ], # min: 1, max: 50; OPTIONAL | ||
| 163 | }, # OPTIONAL | ||
| 164 | }, # OPTIONAL | ||
| 165 | DataSourceParameters => { | ||
| 166 | AmazonElasticsearchParameters => { | ||
| 167 | Domain => 'MyDomain', # min: 1, max: 64 | ||
| 168 | |||
| 169 | }, # OPTIONAL | ||
| 170 | AthenaParameters => { | ||
| 171 | WorkGroup => 'MyWorkGroup', # min: 1, max: 128; OPTIONAL | ||
| 172 | }, # OPTIONAL | ||
| 173 | AuroraParameters => { | ||
| 174 | Database => 'MyDatabase', # min: 1, max: 128 | ||
| 175 | Host => 'MyHost', # min: 1, max: 256 | ||
| 176 | Port => 1, # min: 1, max: 65535 | ||
| 177 | |||
| 178 | }, # OPTIONAL | ||
| 179 | AuroraPostgreSqlParameters => { | ||
| 180 | Database => 'MyDatabase', # min: 1, max: 128 | ||
| 181 | Host => 'MyHost', # min: 1, max: 256 | ||
| 182 | Port => 1, # min: 1, max: 65535 | ||
| 183 | |||
| 184 | }, # OPTIONAL | ||
| 185 | AwsIotAnalyticsParameters => { | ||
| 186 | DataSetName => 'MyDataSetName', # min: 1, max: 128 | ||
| 187 | |||
| 188 | }, # OPTIONAL | ||
| 189 | JiraParameters => { | ||
| 190 | SiteBaseUrl => 'MySiteBaseUrl', # min: 1, max: 1024 | ||
| 191 | |||
| 192 | }, # OPTIONAL | ||
| 193 | MariaDbParameters => { | ||
| 194 | Database => 'MyDatabase', # min: 1, max: 128 | ||
| 195 | Host => 'MyHost', # min: 1, max: 256 | ||
| 196 | Port => 1, # min: 1, max: 65535 | ||
| 197 | |||
| 198 | }, # OPTIONAL | ||
| 199 | MySqlParameters => { | ||
| 200 | Database => 'MyDatabase', # min: 1, max: 128 | ||
| 201 | Host => 'MyHost', # min: 1, max: 256 | ||
| 202 | Port => 1, # min: 1, max: 65535 | ||
| 203 | |||
| 204 | }, # OPTIONAL | ||
| 205 | OracleParameters => { | ||
| 206 | Database => 'MyDatabase', # min: 1, max: 128 | ||
| 207 | Host => 'MyHost', # min: 1, max: 256 | ||
| 208 | Port => 1, # min: 1, max: 65535 | ||
| 209 | |||
| 210 | }, # OPTIONAL | ||
| 211 | PostgreSqlParameters => { | ||
| 212 | Database => 'MyDatabase', # min: 1, max: 128 | ||
| 213 | Host => 'MyHost', # min: 1, max: 256 | ||
| 214 | Port => 1, # min: 1, max: 65535 | ||
| 215 | |||
| 216 | }, # OPTIONAL | ||
| 217 | PrestoParameters => { | ||
| 218 | Catalog => 'MyCatalog', # max: 128 | ||
| 219 | Host => 'MyHost', # min: 1, max: 256 | ||
| 220 | Port => 1, # min: 1, max: 65535 | ||
| 221 | |||
| 222 | }, # OPTIONAL | ||
| 223 | RdsParameters => { | ||
| 224 | Database => 'MyDatabase', # min: 1, max: 128 | ||
| 225 | InstanceId => 'MyInstanceId', # min: 1, max: 64 | ||
| 226 | |||
| 227 | }, # OPTIONAL | ||
| 228 | RedshiftParameters => { | ||
| 229 | Database => 'MyDatabase', # min: 1, max: 128 | ||
| 230 | ClusterId => 'MyClusterId', # min: 1, max: 64; OPTIONAL | ||
| 231 | Host => 'MyHost', # min: 1, max: 256 | ||
| 232 | Port => 1, # max: 65535; OPTIONAL | ||
| 233 | }, # OPTIONAL | ||
| 234 | S3Parameters => { | ||
| 235 | ManifestFileLocation => { | ||
| 236 | Bucket => 'MyS3Bucket', # min: 1, max: 1024 | ||
| 237 | Key => 'MyS3Key', # min: 1, max: 1024 | ||
| 238 | |||
| 239 | }, | ||
| 240 | |||
| 241 | }, # OPTIONAL | ||
| 242 | ServiceNowParameters => { | ||
| 243 | SiteBaseUrl => 'MySiteBaseUrl', # min: 1, max: 1024 | ||
| 244 | |||
| 245 | }, # OPTIONAL | ||
| 246 | SnowflakeParameters => { | ||
| 247 | Database => 'MyDatabase', # min: 1, max: 128 | ||
| 248 | Host => 'MyHost', # min: 1, max: 256 | ||
| 249 | Warehouse => 'MyWarehouse', # max: 128 | ||
| 250 | |||
| 251 | }, # OPTIONAL | ||
| 252 | SparkParameters => { | ||
| 253 | Host => 'MyHost', # min: 1, max: 256 | ||
| 254 | Port => 1, # min: 1, max: 65535 | ||
| 255 | |||
| 256 | }, # OPTIONAL | ||
| 257 | SqlServerParameters => { | ||
| 258 | Database => 'MyDatabase', # min: 1, max: 128 | ||
| 259 | Host => 'MyHost', # min: 1, max: 256 | ||
| 260 | Port => 1, # min: 1, max: 65535 | ||
| 261 | |||
| 262 | }, # OPTIONAL | ||
| 263 | TeradataParameters => { | ||
| 264 | Database => 'MyDatabase', # min: 1, max: 128 | ||
| 265 | Host => 'MyHost', # min: 1, max: 256 | ||
| 266 | Port => 1, # min: 1, max: 65535 | ||
| 267 | |||
| 268 | }, # OPTIONAL | ||
| 269 | TwitterParameters => { | ||
| 270 | MaxRows => 1, # min: 1 | ||
| 271 | Query => 'MyQuery', # min: 1, max: 256 | ||
| 272 | |||
| 273 | }, # OPTIONAL | ||
| 274 | }, # OPTIONAL | ||
| 275 | Permissions => [ | ||
| 276 | { | ||
| 277 | Actions => [ 'MyString', ... ], # min: 1, max: 16 | ||
| 278 | Principal => 'MyPrincipal', # min: 1, max: 256 | ||
| 279 | |||
| 280 | }, | ||
| 281 | ... | ||
| 282 | ], # OPTIONAL | ||
| 283 | SslProperties => { | ||
| 284 | DisableSsl => 1, # OPTIONAL | ||
| 285 | }, # OPTIONAL | ||
| 286 | Tags => [ | ||
| 287 | { | ||
| 288 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 289 | Value => 'MyTagValue', # min: 1, max: 256 | ||
| 290 | |||
| 291 | }, | ||
| 292 | ... | ||
| 293 | ], # OPTIONAL | ||
| 294 | VpcConnectionProperties => { | ||
| 295 | VpcConnectionArn => 'MyArn', | ||
| 296 | |||
| 297 | }, # OPTIONAL | ||
| 298 | ); | ||
| 299 | |||
| 300 | # Results: | ||
| 301 | my $Arn = $CreateDataSourceResponse->Arn; | ||
| 302 | my $CreationStatus = $CreateDataSourceResponse->CreationStatus; | ||
| 303 | my $DataSourceId = $CreateDataSourceResponse->DataSourceId; | ||
| 304 | my $RequestId = $CreateDataSourceResponse->RequestId; | ||
| 305 | my $Status = $CreateDataSourceResponse->Status; | ||
| 306 | |||
| 307 | # Returns a L<Paws::Quicksight::CreateDataSourceResponse> object. | ||
| 308 | |||
| 309 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 310 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/quicksight/CreateDataSource> | ||
| 311 | |||
| 312 | =head1 ATTRIBUTES | ||
| 313 | |||
| 314 | |||
| 315 | =head2 B<REQUIRED> AwsAccountId => Str | ||
| 316 | |||
| 317 | The AWS account ID. | ||
| 318 | |||
| 319 | |||
| 320 | |||
| 321 | =head2 Credentials => L<Paws::Quicksight::DataSourceCredentials> | ||
| 322 | |||
| 323 | The credentials QuickSight that uses to connect to your underlying | ||
| 324 | source. Currently, only credentials based on user name and password are | ||
| 325 | supported. | ||
| 326 | |||
| 327 | |||
| 328 | |||
| 329 | =head2 B<REQUIRED> DataSourceId => Str | ||
| 330 | |||
| 331 | An ID for the data source. This ID is unique per AWS Region for each | ||
| 332 | AWS account. | ||
| 333 | |||
| 334 | |||
| 335 | |||
| 336 | =head2 DataSourceParameters => L<Paws::Quicksight::DataSourceParameters> | ||
| 337 | |||
| 338 | The parameters that QuickSight uses to connect to your underlying | ||
| 339 | source. | ||
| 340 | |||
| 341 | |||
| 342 | |||
| 343 | =head2 B<REQUIRED> Name => Str | ||
| 344 | |||
| 345 | A display name for the data source. | ||
| 346 | |||
| 347 | |||
| 348 | |||
| 349 | =head2 Permissions => ArrayRef[L<Paws::Quicksight::ResourcePermission>] | ||
| 350 | |||
| 351 | A list of resource permissions on the data source. | ||
| 352 | |||
| 353 | |||
| 354 | |||
| 355 | =head2 SslProperties => L<Paws::Quicksight::SslProperties> | ||
| 356 | |||
| 357 | Secure Socket Layer (SSL) properties that apply when QuickSight | ||
| 358 | connects to your underlying source. | ||
| 359 | |||
| 360 | |||
| 361 | |||
| 362 | =head2 Tags => ArrayRef[L<Paws::Quicksight::Tag>] | ||
| 363 | |||
| 364 | Contains a map of the key-value pairs for the resource tag or tags | ||
| 365 | assigned to the data source. | ||
| 366 | |||
| 367 | |||
| 368 | |||
| 369 | =head2 B<REQUIRED> Type => Str | ||
| 370 | |||
| 371 | The type of the data source. Currently, the supported types for this | ||
| 372 | operation are: C<ATHENA, AURORA, AURORA_POSTGRESQL, | ||
| 373 | AMAZON_ELASTICSEARCH, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT, S3, | ||
| 374 | SNOWFLAKE, SPARK, SQLSERVER, TERADATA>. Use C<ListDataSources> to | ||
| 375 | return a list of all data sources. | ||
| 376 | |||
| 377 | C<AMAZON_ELASTICSEARCH> is for Amazon managed Elasticsearch Service. | ||
| 378 | |||
| 379 | Valid values are: C<"ADOBE_ANALYTICS">, C<"AMAZON_ELASTICSEARCH">, C<"ATHENA">, C<"AURORA">, C<"AURORA_POSTGRESQL">, C<"AWS_IOT_ANALYTICS">, C<"GITHUB">, C<"JIRA">, C<"MARIADB">, C<"MYSQL">, C<"ORACLE">, C<"POSTGRESQL">, C<"PRESTO">, C<"REDSHIFT">, C<"S3">, C<"SALESFORCE">, C<"SERVICENOW">, C<"SNOWFLAKE">, C<"SPARK">, C<"SQLSERVER">, C<"TERADATA">, C<"TWITTER">, C<"TIMESTREAM"> | ||
| 380 | |||
| 381 | =head2 VpcConnectionProperties => L<Paws::Quicksight::VpcConnectionProperties> | ||
| 382 | |||
| 383 | Use this parameter only when you want QuickSight to use a VPC | ||
| 384 | connection when connecting to your underlying source. | ||
| 385 | |||
| 386 | |||
| 387 | |||
| 388 | |||
| 389 | =head1 SEE ALSO | ||
| 390 | |||
| 391 | This class forms part of L<Paws>, documenting arguments for method CreateDataSource in L<Paws::Quicksight> | ||
| 392 | |||
| 393 | =head1 BUGS and CONTRIBUTIONS | ||
| 394 | |||
| 395 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 396 | |||
| 397 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 398 | |||
| 399 | =cut | ||
| 400 |