libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudWatchEvents.Types.RedshiftDataParameters

Description

 
Synopsis

Documentation

data RedshiftDataParameters Source #

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.

See: newRedshiftDataParameters smart constructor.

Constructors

RedshiftDataParameters' 

Fields

  • dbUser :: Maybe Text

    The database user name. Required when authenticating using temporary credentials.

  • secretManagerArn :: Maybe Text

    The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager.

  • statementName :: Maybe Text

    The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

  • withEvent :: Maybe Bool

    Indicates whether to send an event back to EventBridge after the SQL statement runs.

  • database :: Text

    The name of the database. Required when authenticating using temporary credentials.

  • sql :: Text

    The SQL statement text to run.

Instances

Instances details
Eq RedshiftDataParameters Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.RedshiftDataParameters

Methods

(==) :: RedshiftDataParameters -> RedshiftDataParameters -> Bool #

(/=) :: RedshiftDataParameters -> RedshiftDataParameters -> Bool #

Read RedshiftDataParameters Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.RedshiftDataParameters

Methods

readsPrec :: Int -> ReadS RedshiftDataParameters #

readList :: ReadS [RedshiftDataParameters] #

readPrec :: ReadPrec RedshiftDataParameters #

readListPrec :: ReadPrec [RedshiftDataParameters] #

Show RedshiftDataParameters Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.RedshiftDataParameters

Methods

showsPrec :: Int -> RedshiftDataParameters -> ShowS #

show :: RedshiftDataParameters -> String #

showList :: [RedshiftDataParameters] -> ShowS #

Generic RedshiftDataParameters Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.RedshiftDataParameters

Associated Types

type Rep RedshiftDataParameters :: Type -> Type #

Methods

from :: RedshiftDataParameters -> Rep RedshiftDataParameters x #

to :: Rep RedshiftDataParameters x -> RedshiftDataParameters #

NFData RedshiftDataParameters Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.RedshiftDataParameters

Methods

rnf :: RedshiftDataParameters -> () #

Hashable RedshiftDataParameters Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.RedshiftDataParameters

Methods

hashWithSalt :: Int -> RedshiftDataParameters -> Int #

hash :: RedshiftDataParameters -> Int #

ToJSON RedshiftDataParameters Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.RedshiftDataParameters

Methods

toJSON :: RedshiftDataParameters -> Value #

toEncoding :: RedshiftDataParameters -> Encoding #

toJSONList :: [RedshiftDataParameters] -> Value #

toEncodingList :: [RedshiftDataParameters] -> Encoding #

FromJSON RedshiftDataParameters Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.RedshiftDataParameters

Methods

parseJSON :: Value -> Parser RedshiftDataParameters #

parseJSONList :: Value -> Parser [RedshiftDataParameters] #

type Rep RedshiftDataParameters Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.RedshiftDataParameters

type Rep RedshiftDataParameters = D1 ('MetaData "RedshiftDataParameters" "Amazonka.CloudWatchEvents.Types.RedshiftDataParameters" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "RedshiftDataParameters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbUser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "secretManagerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "statementName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "withEvent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "database") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sql") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newRedshiftDataParameters Source #

Arguments

:: Text

$sel:database:RedshiftDataParameters'

-> Text

$sel:sql:RedshiftDataParameters'

-> RedshiftDataParameters 

Create a value of RedshiftDataParameters 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:dbUser:RedshiftDataParameters', redshiftDataParameters_dbUser - The database user name. Required when authenticating using temporary credentials.

$sel:secretManagerArn:RedshiftDataParameters', redshiftDataParameters_secretManagerArn - The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager.

$sel:statementName:RedshiftDataParameters', redshiftDataParameters_statementName - The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

$sel:withEvent:RedshiftDataParameters', redshiftDataParameters_withEvent - Indicates whether to send an event back to EventBridge after the SQL statement runs.

$sel:database:RedshiftDataParameters', redshiftDataParameters_database - The name of the database. Required when authenticating using temporary credentials.

$sel:sql:RedshiftDataParameters', redshiftDataParameters_sql - The SQL statement text to run.

redshiftDataParameters_dbUser :: Lens' RedshiftDataParameters (Maybe Text) Source #

The database user name. Required when authenticating using temporary credentials.

redshiftDataParameters_secretManagerArn :: Lens' RedshiftDataParameters (Maybe Text) Source #

The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager.

redshiftDataParameters_statementName :: Lens' RedshiftDataParameters (Maybe Text) Source #

The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

redshiftDataParameters_withEvent :: Lens' RedshiftDataParameters (Maybe Bool) Source #

Indicates whether to send an event back to EventBridge after the SQL statement runs.

redshiftDataParameters_database :: Lens' RedshiftDataParameters Text Source #

The name of the database. Required when authenticating using temporary credentials.

redshiftDataParameters_sql :: Lens' RedshiftDataParameters Text Source #

The SQL statement text to run.