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 |
Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.
Synopsis
- data CreatePipe = CreatePipe' {
- description :: Maybe (Sensitive Text)
- desiredState :: Maybe RequestedPipeState
- enrichment :: Maybe Text
- enrichmentParameters :: Maybe PipeEnrichmentParameters
- sourceParameters :: Maybe PipeSourceParameters
- tags :: Maybe (HashMap Text (Sensitive Text))
- targetParameters :: Maybe PipeTargetParameters
- name :: Text
- roleArn :: Text
- source :: Text
- target :: Text
- newCreatePipe :: Text -> Text -> Text -> Text -> CreatePipe
- createPipe_description :: Lens' CreatePipe (Maybe Text)
- createPipe_desiredState :: Lens' CreatePipe (Maybe RequestedPipeState)
- createPipe_enrichment :: Lens' CreatePipe (Maybe Text)
- createPipe_enrichmentParameters :: Lens' CreatePipe (Maybe PipeEnrichmentParameters)
- createPipe_sourceParameters :: Lens' CreatePipe (Maybe PipeSourceParameters)
- createPipe_tags :: Lens' CreatePipe (Maybe (HashMap Text Text))
- createPipe_targetParameters :: Lens' CreatePipe (Maybe PipeTargetParameters)
- createPipe_name :: Lens' CreatePipe Text
- createPipe_roleArn :: Lens' CreatePipe Text
- createPipe_source :: Lens' CreatePipe Text
- createPipe_target :: Lens' CreatePipe Text
- data CreatePipeResponse = CreatePipeResponse' {}
- newCreatePipeResponse :: Int -> CreatePipeResponse
- createPipeResponse_arn :: Lens' CreatePipeResponse (Maybe Text)
- createPipeResponse_creationTime :: Lens' CreatePipeResponse (Maybe UTCTime)
- createPipeResponse_currentState :: Lens' CreatePipeResponse (Maybe PipeState)
- createPipeResponse_desiredState :: Lens' CreatePipeResponse (Maybe RequestedPipeState)
- createPipeResponse_lastModifiedTime :: Lens' CreatePipeResponse (Maybe UTCTime)
- createPipeResponse_name :: Lens' CreatePipeResponse (Maybe Text)
- createPipeResponse_httpStatus :: Lens' CreatePipeResponse Int
Creating a Request
data CreatePipe Source #
See: newCreatePipe
smart constructor.
CreatePipe' | |
|
Instances
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) Source #
A description of the pipe.
createPipe_desiredState :: Lens' CreatePipe (Maybe RequestedPipeState) Source #
The state the pipe should be in.
createPipe_enrichment :: Lens' CreatePipe (Maybe Text) Source #
The ARN of the enrichment resource.
createPipe_enrichmentParameters :: Lens' CreatePipe (Maybe PipeEnrichmentParameters) Source #
The parameters required to set up enrichment on your pipe.
createPipe_sourceParameters :: Lens' CreatePipe (Maybe PipeSourceParameters) Source #
The parameters required to set up a source for your pipe.
createPipe_tags :: Lens' CreatePipe (Maybe (HashMap Text Text)) Source #
The list of key-value pairs to associate with the pipe.
createPipe_targetParameters :: Lens' CreatePipe (Maybe PipeTargetParameters) Source #
The parameters required to set up a target for your pipe.
createPipe_name :: Lens' CreatePipe Text Source #
The name of the pipe.
createPipe_roleArn :: Lens' CreatePipe Text Source #
The ARN of the role that allows the pipe to send data to the target.
createPipe_source :: Lens' CreatePipe Text Source #
The ARN of the source resource.
createPipe_target :: Lens' CreatePipe Text Source #
The ARN of the target resource.
Destructuring the Response
data CreatePipeResponse Source #
See: newCreatePipeResponse
smart constructor.
CreatePipeResponse' | |
|
Instances
newCreatePipeResponse Source #
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) Source #
The ARN of the pipe.
createPipeResponse_creationTime :: Lens' CreatePipeResponse (Maybe UTCTime) Source #
The time the pipe was created.
createPipeResponse_currentState :: Lens' CreatePipeResponse (Maybe PipeState) Source #
The state the pipe is in.
createPipeResponse_desiredState :: Lens' CreatePipeResponse (Maybe RequestedPipeState) Source #
The state the pipe should be in.
createPipeResponse_lastModifiedTime :: Lens' CreatePipeResponse (Maybe UTCTime) Source #
When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
createPipeResponse_name :: Lens' CreatePipeResponse (Maybe Text) Source #
The name of the pipe.
createPipeResponse_httpStatus :: Lens' CreatePipeResponse Int Source #
The response's http status code.