Amazonka.Pipes.CreatePipe

Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

Creating a Request

data CreatePipe

See: newCreatePipe smart constructor.

Constructors

CreatePipe'

Fields

• description :: Maybe (Sensitive Text)

  A description of the pipe.

• desiredState :: Maybe RequestedPipeState

  The state the pipe should be in.

• enrichment :: Maybe Text

  The ARN of the enrichment resource.

• enrichmentParameters :: Maybe PipeEnrichmentParameters

  The parameters required to set up enrichment on your pipe.

• sourceParameters :: Maybe PipeSourceParameters

  The parameters required to set up a source for your pipe.

• tags :: Maybe (HashMap Text (Sensitive Text))

  The list of key-value pairs to associate with the pipe.

• targetParameters :: Maybe PipeTargetParameters

  The parameters required to set up a target for your pipe.

• name :: Text

  The name of the pipe.

• roleArn :: Text

  The ARN of the role that allows the pipe to send data to the target.

• source :: Text

  The ARN of the source resource.

• target :: Text

  The ARN of the target resource.

Instances

ToJSON CreatePipe

Defined in Amazonka.Pipes.CreatePipe

Methods

toJSON :: CreatePipe -> Value

toEncoding :: CreatePipe -> Encoding

toJSONList :: [CreatePipe] -> Value

toEncodingList :: [CreatePipe] -> Encoding

ToHeaders CreatePipe

Defined in Amazonka.Pipes.CreatePipe

Methods

toHeaders :: CreatePipe -> [Header]

ToPath CreatePipe

Defined in Amazonka.Pipes.CreatePipe

Methods

toPath :: CreatePipe -> ByteString

ToQuery CreatePipe

Defined in Amazonka.Pipes.CreatePipe

Methods

toQuery :: CreatePipe -> QueryString

AWSRequest CreatePipe

Defined in Amazonka.Pipes.CreatePipe

Associated Types

type AWSResponse CreatePipe

Methods

request :: (Service -> Service) -> CreatePipe -> Request CreatePipe

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreatePipe -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreatePipe)))

Generic CreatePipe

Defined in Amazonka.Pipes.CreatePipe

Associated Types

type Rep CreatePipe :: Type -> Type

Methods

from :: CreatePipe -> Rep CreatePipe x

to :: Rep CreatePipe x -> CreatePipe

Show CreatePipe

Defined in Amazonka.Pipes.CreatePipe

Methods

showsPrec :: Int -> CreatePipe -> ShowS

show :: CreatePipe -> String

showList :: [CreatePipe] -> ShowS

NFData CreatePipe

Defined in Amazonka.Pipes.CreatePipe

Methods

rnf :: CreatePipe -> ()

Eq CreatePipe

Defined in Amazonka.Pipes.CreatePipe

Methods

(==) :: CreatePipe -> CreatePipe -> Bool

(/=) :: CreatePipe -> CreatePipe -> Bool

Hashable CreatePipe

Defined in Amazonka.Pipes.CreatePipe

Methods

hashWithSalt :: Int -> CreatePipe -> Int

hash :: CreatePipe -> Int

type AWSResponse CreatePipe

Defined in Amazonka.Pipes.CreatePipe

type AWSResponse CreatePipe = CreatePipeResponse

type Rep CreatePipe

Defined in Amazonka.Pipes.CreatePipe

type Rep CreatePipe = D1 ('MetaData "CreatePipe" "Amazonka.Pipes.CreatePipe" "amazonka-pipes-2.0-DDuNjbjVfgsJFLlibzr06i" 'False) (C1 ('MetaCons "CreatePipe'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "desiredState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestedPipeState))) :*: (S1 ('MetaSel ('Just "enrichment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "enrichmentParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipeEnrichmentParameters)) :*: S1 ('MetaSel ('Just "sourceParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipeSourceParameters))))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (Sensitive Text)))) :*: (S1 ('MetaSel ('Just "targetParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipeTargetParameters)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreatePipe

Arguments

:: Text

CreatePipe

-> Text

$sel:roleArn:CreatePipe'

-> Text

CreatePipe

-> Text

CreatePipe

-> CreatePipe

Create a value of CreatePipe 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:description:CreatePipe', createPipe_description - A description of the pipe.

CreatePipe, createPipe_desiredState - The state the pipe should be in.

CreatePipe, createPipe_enrichment - The ARN of the enrichment resource.

$sel:enrichmentParameters:CreatePipe', createPipe_enrichmentParameters - The parameters required to set up enrichment on your pipe.

$sel:sourceParameters:CreatePipe', createPipe_sourceParameters - The parameters required to set up a source for your pipe.

CreatePipe, createPipe_tags - The list of key-value pairs to associate with the pipe.

$sel:targetParameters:CreatePipe', createPipe_targetParameters - The parameters required to set up a target for your pipe.

CreatePipe, createPipe_name - The name of the pipe.

$sel:roleArn:CreatePipe', createPipe_roleArn - The ARN of the role that allows the pipe to send data to the target.

CreatePipe, createPipe_source - The ARN of the source resource.

CreatePipe, createPipe_target - The ARN of the target resource.

Request Lenses

createPipe_description :: Lens' CreatePipe (Maybe Text)

A description of the pipe.

createPipe_desiredState :: Lens' CreatePipe (Maybe RequestedPipeState)

The state the pipe should be in.

createPipe_enrichment :: Lens' CreatePipe (Maybe Text)

The ARN of the enrichment resource.

createPipe_enrichmentParameters :: Lens' CreatePipe (Maybe PipeEnrichmentParameters)

The parameters required to set up enrichment on your pipe.

createPipe_sourceParameters :: Lens' CreatePipe (Maybe PipeSourceParameters)

The parameters required to set up a source for your pipe.

createPipe_tags :: Lens' CreatePipe (Maybe (HashMap Text Text))

The list of key-value pairs to associate with the pipe.

createPipe_targetParameters :: Lens' CreatePipe (Maybe PipeTargetParameters)

The parameters required to set up a target for your pipe.

createPipe_name :: Lens' CreatePipe Text

The name of the pipe.

createPipe_roleArn :: Lens' CreatePipe Text

The ARN of the role that allows the pipe to send data to the target.

createPipe_source :: Lens' CreatePipe Text

The ARN of the source resource.

createPipe_target :: Lens' CreatePipe Text

The ARN of the target resource.

Destructuring the Response

data CreatePipeResponse

See: newCreatePipeResponse smart constructor.

Constructors

CreatePipeResponse'

Fields

• arn :: Maybe Text

  The ARN of the pipe.

• creationTime :: Maybe POSIX

  The time the pipe was created.

• currentState :: Maybe PipeState

  The state the pipe is in.

• desiredState :: Maybe RequestedPipeState

  The state the pipe should be in.

• lastModifiedTime :: Maybe POSIX

  When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

• name :: Maybe Text

  The name of the pipe.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreatePipeResponse

Defined in Amazonka.Pipes.CreatePipe

Associated Types

type Rep CreatePipeResponse :: Type -> Type

Methods

from :: CreatePipeResponse -> Rep CreatePipeResponse x

to :: Rep CreatePipeResponse x -> CreatePipeResponse

Read CreatePipeResponse

Defined in Amazonka.Pipes.CreatePipe

Methods

readsPrec :: Int -> ReadS CreatePipeResponse

readList :: ReadS [CreatePipeResponse]

readPrec :: ReadPrec CreatePipeResponse

readListPrec :: ReadPrec [CreatePipeResponse]

Show CreatePipeResponse

Defined in Amazonka.Pipes.CreatePipe

Methods

showsPrec :: Int -> CreatePipeResponse -> ShowS

show :: CreatePipeResponse -> String

showList :: [CreatePipeResponse] -> ShowS

NFData CreatePipeResponse

Defined in Amazonka.Pipes.CreatePipe

Methods

rnf :: CreatePipeResponse -> ()

Eq CreatePipeResponse

Defined in Amazonka.Pipes.CreatePipe

Methods

(==) :: CreatePipeResponse -> CreatePipeResponse -> Bool

(/=) :: CreatePipeResponse -> CreatePipeResponse -> Bool

type Rep CreatePipeResponse

Defined in Amazonka.Pipes.CreatePipe

type Rep CreatePipeResponse = D1 ('MetaData "CreatePipeResponse" "Amazonka.Pipes.CreatePipe" "amazonka-pipes-2.0-DDuNjbjVfgsJFLlibzr06i" 'False) (C1 ('MetaCons "CreatePipeResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "currentState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipeState)))) :*: ((S1 ('MetaSel ('Just "desiredState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestedPipeState)) :*: S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreatePipeResponse

Arguments

:: Int

$sel:httpStatus:CreatePipeResponse'

-> CreatePipeResponse

Create a value of CreatePipeResponse 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:

CreatePipeResponse, createPipeResponse_arn - The ARN of the pipe.

CreatePipeResponse, createPipeResponse_creationTime - The time the pipe was created.

CreatePipeResponse, createPipeResponse_currentState - The state the pipe is in.

CreatePipe, createPipeResponse_desiredState - The state the pipe should be in.

CreatePipeResponse, createPipeResponse_lastModifiedTime - When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

CreatePipe, createPipeResponse_name - The name of the pipe.

$sel:httpStatus:CreatePipeResponse', createPipeResponse_httpStatus - The response's http status code.

Response Lenses

createPipeResponse_arn :: Lens' CreatePipeResponse (Maybe Text)

The ARN of the pipe.

createPipeResponse_creationTime :: Lens' CreatePipeResponse (Maybe UTCTime)

The time the pipe was created.

createPipeResponse_currentState :: Lens' CreatePipeResponse (Maybe PipeState)

The state the pipe is in.

createPipeResponse_desiredState :: Lens' CreatePipeResponse (Maybe RequestedPipeState)

The state the pipe should be in.

createPipeResponse_lastModifiedTime :: Lens' CreatePipeResponse (Maybe UTCTime)

When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

createPipeResponse_name :: Lens' CreatePipeResponse (Maybe Text)

The name of the pipe.

createPipeResponse_httpStatus :: Lens' CreatePipeResponse Int

The response's http status code.