« blib/lib/Paws/CloudWatchEvents/QueryStringParametersMap.pm
↑ Summary
blib/lib/Paws/CloudWatchEvents/RemovePermission.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudWatchEvents::RedshiftDataParameters; | ||
| 3 | use Moose; | ||
| 4 | has Database => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has DbUser => (is => 'ro', isa => 'Str'); | ||
| 6 | has SecretManagerArn => (is => 'ro', isa => 'Str'); | ||
| 7 | has Sql => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has StatementName => (is => 'ro', isa => 'Str'); | ||
| 9 | has WithEvent => (is => 'ro', isa => 'Bool'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::CloudWatchEvents::RedshiftDataParameters | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::CloudWatchEvents::RedshiftDataParameters object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { Database => $value, ..., WithEvent => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudWatchEvents::RedshiftDataParameters object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->Database | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | These are custom parameters to be used when the target is a Redshift | ||
| 42 | cluster to invoke the Redshift Data API ExecuteStatement based on | ||
| 43 | EventBridge events. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 B<REQUIRED> Database => Str | ||
| 49 | |||
| 50 | The name of the database. Required when authenticating using temporary | ||
| 51 | credentials. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 DbUser => Str | ||
| 55 | |||
| 56 | The database user name. Required when authenticating using temporary | ||
| 57 | credentials. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 SecretManagerArn => Str | ||
| 61 | |||
| 62 | The name or ARN of the secret that enables access to the database. | ||
| 63 | Required when authenticating using AWS Secrets Manager. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> Sql => Str | ||
| 67 | |||
| 68 | The SQL statement text to run. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 StatementName => Str | ||
| 72 | |||
| 73 | The name of the SQL statement. You can name the SQL statement when you | ||
| 74 | create it to identify the query. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 WithEvent => Bool | ||
| 78 | |||
| 79 | Indicates whether to send an event back to EventBridge after the SQL | ||
| 80 | statement runs. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head1 SEE ALSO | ||
| 85 | |||
| 86 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudWatchEvents> | ||
| 87 | |||
| 88 | =head1 BUGS and CONTRIBUTIONS | ||
| 89 | |||
| 90 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 91 | |||
| 92 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 93 | |||
| 94 | =cut | ||
| 95 |