Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Pipes.Types.PipeTargetRedshiftDataParameters

Description

Synopsis

Documentation

data PipeTargetRedshiftDataParameters Source #

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

See: newPipeTargetRedshiftDataParameters smart constructor.

Constructors

PipeTargetRedshiftDataParameters'

Fields

dbUser :: Maybe (Sensitive 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 SageMaker.
statementName :: Maybe (Sensitive 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 :: Sensitive Text
The name of the database. Required when authenticating using temporary credentials.
sqls :: NonEmpty (Sensitive Text)
The SQL statement text to run.

Instances

Instances details

FromJSON PipeTargetRedshiftDataParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetRedshiftDataParameters Methods parseJSON :: Value -> Parser PipeTargetRedshiftDataParameters # parseJSONList :: Value -> Parser [PipeTargetRedshiftDataParameters] #
ToJSON PipeTargetRedshiftDataParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetRedshiftDataParameters Methods toJSON :: PipeTargetRedshiftDataParameters -> Value # toEncoding :: PipeTargetRedshiftDataParameters -> Encoding # toJSONList :: [PipeTargetRedshiftDataParameters] -> Value # toEncodingList :: [PipeTargetRedshiftDataParameters] -> Encoding #
Generic PipeTargetRedshiftDataParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetRedshiftDataParameters Associated Types type Rep PipeTargetRedshiftDataParameters :: Type -> Type # Methods from :: PipeTargetRedshiftDataParameters -> Rep PipeTargetRedshiftDataParameters x # to :: Rep PipeTargetRedshiftDataParameters x -> PipeTargetRedshiftDataParameters #
Show PipeTargetRedshiftDataParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetRedshiftDataParameters Methods showsPrec :: Int -> PipeTargetRedshiftDataParameters -> ShowS # show :: PipeTargetRedshiftDataParameters -> String # showList :: [PipeTargetRedshiftDataParameters] -> ShowS #
NFData PipeTargetRedshiftDataParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetRedshiftDataParameters Methods rnf :: PipeTargetRedshiftDataParameters -> () #
Eq PipeTargetRedshiftDataParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetRedshiftDataParameters Methods (==) :: PipeTargetRedshiftDataParameters -> PipeTargetRedshiftDataParameters -> Bool # (/=) :: PipeTargetRedshiftDataParameters -> PipeTargetRedshiftDataParameters -> Bool #
Hashable PipeTargetRedshiftDataParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetRedshiftDataParameters Methods hashWithSalt :: Int -> PipeTargetRedshiftDataParameters -> Int # hash :: PipeTargetRedshiftDataParameters -> Int #
type Rep PipeTargetRedshiftDataParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetRedshiftDataParameters type Rep PipeTargetRedshiftDataParameters = D1 ('MetaData "PipeTargetRedshiftDataParameters" "Amazonka.Pipes.Types.PipeTargetRedshiftDataParameters" "amazonka-pipes-2.0-DDuNjbjVfgsJFLlibzr06i" 'False) (C1 ('MetaCons "PipeTargetRedshiftDataParameters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbUser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "secretManagerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "statementName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :: (S1 ('MetaSel ('Just "withEvent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "database") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "sqls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty (Sensitive Text)))))))

newPipeTargetRedshiftDataParameters Source #

Arguments

:: Text	`$sel:database:PipeTargetRedshiftDataParameters'`
-> NonEmpty Text	`$sel:sqls:PipeTargetRedshiftDataParameters'`
-> PipeTargetRedshiftDataParameters

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

$sel:secretManagerArn:PipeTargetRedshiftDataParameters', pipeTargetRedshiftDataParameters_secretManagerArn - The name or ARN of the secret that enables access to the database. Required when authenticating using SageMaker.

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

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

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

$sel:sqls:PipeTargetRedshiftDataParameters', pipeTargetRedshiftDataParameters_sqls - The SQL statement text to run.

pipeTargetRedshiftDataParameters_dbUser :: Lens' PipeTargetRedshiftDataParameters (Maybe Text) Source #

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

pipeTargetRedshiftDataParameters_secretManagerArn :: Lens' PipeTargetRedshiftDataParameters (Maybe Text) Source #

The name or ARN of the secret that enables access to the database. Required when authenticating using SageMaker.

pipeTargetRedshiftDataParameters_statementName :: Lens' PipeTargetRedshiftDataParameters (Maybe Text) Source #

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

pipeTargetRedshiftDataParameters_withEvent :: Lens' PipeTargetRedshiftDataParameters (Maybe Bool) Source #

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

pipeTargetRedshiftDataParameters_database :: Lens' PipeTargetRedshiftDataParameters Text Source #

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

pipeTargetRedshiftDataParameters_sqls :: Lens' PipeTargetRedshiftDataParameters (NonEmpty Text) Source #

The SQL statement text to run.