| 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
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- Types
- AssignPublicIp
- BatchJobDependencyType
- BatchResourceRequirementType
- DynamoDBStreamStartPosition
- EcsEnvironmentFileType
- EcsResourceRequirementType
- KinesisStreamStartPosition
- LaunchType
- MSKStartPosition
- OnPartialBatchItemFailureStreams
- PipeState
- PipeTargetInvocationType
- PlacementConstraintType
- PlacementStrategyType
- PropagateTags
- RequestedPipeState
- RequestedPipeStateDescribeResponse
- SelfManagedKafkaStartPosition
- AwsVpcConfiguration
- BatchArrayProperties
- BatchContainerOverrides
- BatchEnvironmentVariable
- BatchJobDependency
- BatchResourceRequirement
- BatchRetryStrategy
- CapacityProviderStrategyItem
- DeadLetterConfig
- EcsContainerOverride
- EcsEnvironmentFile
- EcsEnvironmentVariable
- EcsEphemeralStorage
- EcsInferenceAcceleratorOverride
- EcsResourceRequirement
- EcsTaskOverride
- Filter
- FilterCriteria
- MQBrokerAccessCredentials
- MSKAccessCredentials
- NetworkConfiguration
- Pipe
- PipeEnrichmentHttpParameters
- PipeEnrichmentParameters
- PipeSourceActiveMQBrokerParameters
- PipeSourceDynamoDBStreamParameters
- PipeSourceKinesisStreamParameters
- PipeSourceManagedStreamingKafkaParameters
- PipeSourceParameters
- PipeSourceRabbitMQBrokerParameters
- PipeSourceSelfManagedKafkaParameters
- PipeSourceSqsQueueParameters
- PipeTargetBatchJobParameters
- PipeTargetCloudWatchLogsParameters
- PipeTargetEcsTaskParameters
- PipeTargetEventBridgeEventBusParameters
- PipeTargetHttpParameters
- PipeTargetKinesisStreamParameters
- PipeTargetLambdaFunctionParameters
- PipeTargetParameters
- PipeTargetRedshiftDataParameters
- PipeTargetSageMakerPipelineParameters
- PipeTargetSqsQueueParameters
- PipeTargetStateMachineParameters
- PlacementConstraint
- PlacementStrategy
- SageMakerPipelineParameter
- SelfManagedKafkaAccessConfigurationCredentials
- SelfManagedKafkaAccessConfigurationVpc
- Tag
- UpdatePipeSourceActiveMQBrokerParameters
- UpdatePipeSourceDynamoDBStreamParameters
- UpdatePipeSourceKinesisStreamParameters
- UpdatePipeSourceManagedStreamingKafkaParameters
- UpdatePipeSourceParameters
- UpdatePipeSourceRabbitMQBrokerParameters
- UpdatePipeSourceSelfManagedKafkaParameters
- UpdatePipeSourceSqsQueueParameters
Description
Derived from API version 2015-10-07 of the AWS service descriptions, licensed under Apache 2.0.
Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need for specialized knowledge and integration code when developing event driven architectures. This helps ensures consistency across your company’s applications. With Pipes, the target can be any available EventBridge target. To set up a pipe, you select the event source, add optional event filtering, define optional enrichment, and select the target for the event data.
Synopsis
- defaultService :: Service
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalException :: AsError a => Fold a ServiceError
- _NotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data CreatePipe = CreatePipe' (Maybe (Sensitive Text)) (Maybe RequestedPipeState) (Maybe Text) (Maybe PipeEnrichmentParameters) (Maybe PipeSourceParameters) (Maybe (HashMap Text (Sensitive Text))) (Maybe PipeTargetParameters) Text Text Text Text
- newCreatePipe :: Text -> Text -> Text -> Text -> CreatePipe
- data CreatePipeResponse = CreatePipeResponse' (Maybe Text) (Maybe POSIX) (Maybe PipeState) (Maybe RequestedPipeState) (Maybe POSIX) (Maybe Text) Int
- newCreatePipeResponse :: Int -> CreatePipeResponse
- data DeletePipe = DeletePipe' Text
- newDeletePipe :: Text -> DeletePipe
- data DeletePipeResponse = DeletePipeResponse' (Maybe Text) (Maybe POSIX) (Maybe PipeState) (Maybe RequestedPipeStateDescribeResponse) (Maybe POSIX) (Maybe Text) Int
- newDeletePipeResponse :: Int -> DeletePipeResponse
- data DescribePipe = DescribePipe' Text
- newDescribePipe :: Text -> DescribePipe
- data DescribePipeResponse = DescribePipeResponse' (Maybe Text) (Maybe POSIX) (Maybe PipeState) (Maybe (Sensitive Text)) (Maybe RequestedPipeStateDescribeResponse) (Maybe Text) (Maybe PipeEnrichmentParameters) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe PipeSourceParameters) (Maybe Text) (Maybe (HashMap Text (Sensitive Text))) (Maybe Text) (Maybe PipeTargetParameters) Int
- newDescribePipeResponse :: Int -> DescribePipeResponse
- data ListPipes = ListPipes' (Maybe PipeState) (Maybe RequestedPipeState) (Maybe Natural) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text)
- newListPipes :: ListPipes
- data ListPipesResponse = ListPipesResponse' (Maybe (Sensitive Text)) (Maybe [Pipe]) Int
- newListPipesResponse :: Int -> ListPipesResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text (Sensitive Text))) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data StartPipe = StartPipe' Text
- newStartPipe :: Text -> StartPipe
- data StartPipeResponse = StartPipeResponse' (Maybe Text) (Maybe POSIX) (Maybe PipeState) (Maybe RequestedPipeState) (Maybe POSIX) (Maybe Text) Int
- newStartPipeResponse :: Int -> StartPipeResponse
- data StopPipe = StopPipe' Text
- newStopPipe :: Text -> StopPipe
- data StopPipeResponse = StopPipeResponse' (Maybe Text) (Maybe POSIX) (Maybe PipeState) (Maybe RequestedPipeState) (Maybe POSIX) (Maybe Text) Int
- newStopPipeResponse :: Int -> StopPipeResponse
- data TagResource = TagResource' Text (HashMap Text (Sensitive Text))
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdatePipe = UpdatePipe' (Maybe (Sensitive Text)) (Maybe RequestedPipeState) (Maybe Text) (Maybe PipeEnrichmentParameters) (Maybe UpdatePipeSourceParameters) (Maybe Text) (Maybe PipeTargetParameters) Text Text
- newUpdatePipe :: Text -> Text -> UpdatePipe
- data UpdatePipeResponse = UpdatePipeResponse' (Maybe Text) (Maybe POSIX) (Maybe PipeState) (Maybe RequestedPipeState) (Maybe POSIX) (Maybe Text) Int
- newUpdatePipeResponse :: Int -> UpdatePipeResponse
- newtype AssignPublicIp where
- AssignPublicIp' { }
- pattern AssignPublicIp_DISABLED :: AssignPublicIp
- pattern AssignPublicIp_ENABLED :: AssignPublicIp
- newtype BatchJobDependencyType where
- newtype BatchResourceRequirementType where
- newtype DynamoDBStreamStartPosition where
- newtype EcsEnvironmentFileType where
- newtype EcsResourceRequirementType where
- newtype KinesisStreamStartPosition where
- newtype LaunchType where
- LaunchType' { }
- pattern LaunchType_EC2 :: LaunchType
- pattern LaunchType_EXTERNAL :: LaunchType
- pattern LaunchType_FARGATE :: LaunchType
- newtype MSKStartPosition where
- MSKStartPosition' { }
- pattern MSKStartPosition_LATEST :: MSKStartPosition
- pattern MSKStartPosition_TRIM_HORIZON :: MSKStartPosition
- newtype OnPartialBatchItemFailureStreams where
- newtype PipeState where
- PipeState' { }
- pattern PipeState_CREATE_FAILED :: PipeState
- pattern PipeState_CREATING :: PipeState
- pattern PipeState_DELETING :: PipeState
- pattern PipeState_RUNNING :: PipeState
- pattern PipeState_STARTING :: PipeState
- pattern PipeState_START_FAILED :: PipeState
- pattern PipeState_STOPPED :: PipeState
- pattern PipeState_STOPPING :: PipeState
- pattern PipeState_STOP_FAILED :: PipeState
- pattern PipeState_UPDATE_FAILED :: PipeState
- pattern PipeState_UPDATING :: PipeState
- newtype PipeTargetInvocationType where
- newtype PlacementConstraintType where
- newtype PlacementStrategyType where
- newtype PropagateTags where
- PropagateTags' { }
- pattern PropagateTags_TASK_DEFINITION :: PropagateTags
- newtype RequestedPipeState where
- newtype RequestedPipeStateDescribeResponse where
- RequestedPipeStateDescribeResponse' { }
- pattern RequestedPipeStateDescribeResponse_DELETED :: RequestedPipeStateDescribeResponse
- pattern RequestedPipeStateDescribeResponse_RUNNING :: RequestedPipeStateDescribeResponse
- pattern RequestedPipeStateDescribeResponse_STOPPED :: RequestedPipeStateDescribeResponse
- newtype SelfManagedKafkaStartPosition where
- data AwsVpcConfiguration = AwsVpcConfiguration' (Maybe AssignPublicIp) (Maybe [Sensitive Text]) [Sensitive Text]
- newAwsVpcConfiguration :: AwsVpcConfiguration
- data BatchArrayProperties = BatchArrayProperties' (Maybe Natural)
- newBatchArrayProperties :: BatchArrayProperties
- data BatchContainerOverrides = BatchContainerOverrides' (Maybe [Text]) (Maybe [BatchEnvironmentVariable]) (Maybe Text) (Maybe [BatchResourceRequirement])
- newBatchContainerOverrides :: BatchContainerOverrides
- data BatchEnvironmentVariable = BatchEnvironmentVariable' (Maybe Text) (Maybe Text)
- newBatchEnvironmentVariable :: BatchEnvironmentVariable
- data BatchJobDependency = BatchJobDependency' (Maybe Text) (Maybe BatchJobDependencyType)
- newBatchJobDependency :: BatchJobDependency
- data BatchResourceRequirement = BatchResourceRequirement' BatchResourceRequirementType Text
- newBatchResourceRequirement :: BatchResourceRequirementType -> Text -> BatchResourceRequirement
- data BatchRetryStrategy = BatchRetryStrategy' (Maybe Natural)
- newBatchRetryStrategy :: BatchRetryStrategy
- data CapacityProviderStrategyItem = CapacityProviderStrategyItem' (Maybe Natural) (Maybe Natural) (Sensitive Text)
- newCapacityProviderStrategyItem :: Text -> CapacityProviderStrategyItem
- data DeadLetterConfig = DeadLetterConfig' (Maybe Text)
- newDeadLetterConfig :: DeadLetterConfig
- data EcsContainerOverride = EcsContainerOverride' (Maybe [Text]) (Maybe Int) (Maybe [EcsEnvironmentVariable]) (Maybe [EcsEnvironmentFile]) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe [EcsResourceRequirement])
- newEcsContainerOverride :: EcsContainerOverride
- data EcsEnvironmentFile = EcsEnvironmentFile' EcsEnvironmentFileType Text
- newEcsEnvironmentFile :: EcsEnvironmentFileType -> Text -> EcsEnvironmentFile
- data EcsEnvironmentVariable = EcsEnvironmentVariable' (Maybe Text) (Maybe Text)
- newEcsEnvironmentVariable :: EcsEnvironmentVariable
- data EcsEphemeralStorage = EcsEphemeralStorage' Natural
- newEcsEphemeralStorage :: Natural -> EcsEphemeralStorage
- data EcsInferenceAcceleratorOverride = EcsInferenceAcceleratorOverride' (Maybe Text) (Maybe Text)
- newEcsInferenceAcceleratorOverride :: EcsInferenceAcceleratorOverride
- data EcsResourceRequirement = EcsResourceRequirement' EcsResourceRequirementType Text
- newEcsResourceRequirement :: EcsResourceRequirementType -> Text -> EcsResourceRequirement
- data EcsTaskOverride = EcsTaskOverride' (Maybe [EcsContainerOverride]) (Maybe Text) (Maybe EcsEphemeralStorage) (Maybe Text) (Maybe [EcsInferenceAcceleratorOverride]) (Maybe Text) (Maybe Text)
- newEcsTaskOverride :: EcsTaskOverride
- data Filter = Filter' (Maybe (Sensitive Text))
- newFilter :: Filter
- data FilterCriteria = FilterCriteria' (Maybe [Filter])
- newFilterCriteria :: FilterCriteria
- data MQBrokerAccessCredentials = MQBrokerAccessCredentials' (Maybe Text)
- newMQBrokerAccessCredentials :: MQBrokerAccessCredentials
- data MSKAccessCredentials = MSKAccessCredentials' (Maybe Text) (Maybe Text)
- newMSKAccessCredentials :: MSKAccessCredentials
- data NetworkConfiguration = NetworkConfiguration' (Maybe AwsVpcConfiguration)
- newNetworkConfiguration :: NetworkConfiguration
- data Pipe = Pipe' (Maybe Text) (Maybe POSIX) (Maybe PipeState) (Maybe RequestedPipeState) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newPipe :: Pipe
- data PipeEnrichmentHttpParameters = PipeEnrichmentHttpParameters' (Maybe (HashMap Text (Sensitive Text))) (Maybe [Sensitive Text]) (Maybe (HashMap Text (Sensitive Text)))
- newPipeEnrichmentHttpParameters :: PipeEnrichmentHttpParameters
- data PipeEnrichmentParameters = PipeEnrichmentParameters' (Maybe PipeEnrichmentHttpParameters) (Maybe (Sensitive Text))
- newPipeEnrichmentParameters :: PipeEnrichmentParameters
- data PipeSourceActiveMQBrokerParameters = PipeSourceActiveMQBrokerParameters' (Maybe Natural) (Maybe Natural) MQBrokerAccessCredentials (Sensitive Text)
- newPipeSourceActiveMQBrokerParameters :: MQBrokerAccessCredentials -> Text -> PipeSourceActiveMQBrokerParameters
- data PipeSourceDynamoDBStreamParameters = PipeSourceDynamoDBStreamParameters' (Maybe Natural) (Maybe DeadLetterConfig) (Maybe Natural) (Maybe Int) (Maybe Int) (Maybe OnPartialBatchItemFailureStreams) (Maybe Natural) DynamoDBStreamStartPosition
- newPipeSourceDynamoDBStreamParameters :: DynamoDBStreamStartPosition -> PipeSourceDynamoDBStreamParameters
- data PipeSourceKinesisStreamParameters = PipeSourceKinesisStreamParameters' (Maybe Natural) (Maybe DeadLetterConfig) (Maybe Natural) (Maybe Int) (Maybe Int) (Maybe OnPartialBatchItemFailureStreams) (Maybe Natural) (Maybe POSIX) KinesisStreamStartPosition
- newPipeSourceKinesisStreamParameters :: KinesisStreamStartPosition -> PipeSourceKinesisStreamParameters
- data PipeSourceManagedStreamingKafkaParameters = PipeSourceManagedStreamingKafkaParameters' (Maybe Natural) (Maybe (Sensitive Text)) (Maybe MSKAccessCredentials) (Maybe Natural) (Maybe MSKStartPosition) (Sensitive Text)
- newPipeSourceManagedStreamingKafkaParameters :: Text -> PipeSourceManagedStreamingKafkaParameters
- data PipeSourceParameters = PipeSourceParameters' (Maybe PipeSourceActiveMQBrokerParameters) (Maybe PipeSourceDynamoDBStreamParameters) (Maybe FilterCriteria) (Maybe PipeSourceKinesisStreamParameters) (Maybe PipeSourceManagedStreamingKafkaParameters) (Maybe PipeSourceRabbitMQBrokerParameters) (Maybe PipeSourceSelfManagedKafkaParameters) (Maybe PipeSourceSqsQueueParameters)
- newPipeSourceParameters :: PipeSourceParameters
- data PipeSourceRabbitMQBrokerParameters = PipeSourceRabbitMQBrokerParameters' (Maybe Natural) (Maybe Natural) (Maybe (Sensitive Text)) MQBrokerAccessCredentials (Sensitive Text)
- newPipeSourceRabbitMQBrokerParameters :: MQBrokerAccessCredentials -> Text -> PipeSourceRabbitMQBrokerParameters
- data PipeSourceSelfManagedKafkaParameters = PipeSourceSelfManagedKafkaParameters' (Maybe [Sensitive Text]) (Maybe Natural) (Maybe (Sensitive Text)) (Maybe SelfManagedKafkaAccessConfigurationCredentials) (Maybe Natural) (Maybe Text) (Maybe SelfManagedKafkaStartPosition) (Maybe SelfManagedKafkaAccessConfigurationVpc) (Sensitive Text)
- newPipeSourceSelfManagedKafkaParameters :: Text -> PipeSourceSelfManagedKafkaParameters
- data PipeSourceSqsQueueParameters = PipeSourceSqsQueueParameters' (Maybe Natural) (Maybe Natural)
- newPipeSourceSqsQueueParameters :: PipeSourceSqsQueueParameters
- data PipeTargetBatchJobParameters = PipeTargetBatchJobParameters' (Maybe BatchArrayProperties) (Maybe BatchContainerOverrides) (Maybe [BatchJobDependency]) (Maybe (HashMap Text Text)) (Maybe BatchRetryStrategy) Text Text
- newPipeTargetBatchJobParameters :: Text -> Text -> PipeTargetBatchJobParameters
- data PipeTargetCloudWatchLogsParameters = PipeTargetCloudWatchLogsParameters' (Maybe Text) (Maybe Text)
- newPipeTargetCloudWatchLogsParameters :: PipeTargetCloudWatchLogsParameters
- data PipeTargetEcsTaskParameters = PipeTargetEcsTaskParameters' (Maybe [CapacityProviderStrategyItem]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe LaunchType) (Maybe NetworkConfiguration) (Maybe EcsTaskOverride) (Maybe [PlacementConstraint]) (Maybe [PlacementStrategy]) (Maybe Text) (Maybe PropagateTags) (Maybe (Sensitive Text)) (Maybe [Tag]) (Maybe Natural) Text
- newPipeTargetEcsTaskParameters :: Text -> PipeTargetEcsTaskParameters
- data PipeTargetEventBridgeEventBusParameters = PipeTargetEventBridgeEventBusParameters' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe [Text]) (Maybe (Sensitive Text)) (Maybe Text)
- newPipeTargetEventBridgeEventBusParameters :: PipeTargetEventBridgeEventBusParameters
- data PipeTargetHttpParameters = PipeTargetHttpParameters' (Maybe (HashMap Text (Sensitive Text))) (Maybe [Sensitive Text]) (Maybe (HashMap Text (Sensitive Text)))
- newPipeTargetHttpParameters :: PipeTargetHttpParameters
- data PipeTargetKinesisStreamParameters = PipeTargetKinesisStreamParameters' (Sensitive Text)
- newPipeTargetKinesisStreamParameters :: Text -> PipeTargetKinesisStreamParameters
- data PipeTargetLambdaFunctionParameters = PipeTargetLambdaFunctionParameters' (Maybe PipeTargetInvocationType)
- newPipeTargetLambdaFunctionParameters :: PipeTargetLambdaFunctionParameters
- data PipeTargetParameters = PipeTargetParameters' (Maybe PipeTargetBatchJobParameters) (Maybe PipeTargetCloudWatchLogsParameters) (Maybe PipeTargetEcsTaskParameters) (Maybe PipeTargetEventBridgeEventBusParameters) (Maybe PipeTargetHttpParameters) (Maybe (Sensitive Text)) (Maybe PipeTargetKinesisStreamParameters) (Maybe PipeTargetLambdaFunctionParameters) (Maybe PipeTargetRedshiftDataParameters) (Maybe PipeTargetSageMakerPipelineParameters) (Maybe PipeTargetSqsQueueParameters) (Maybe PipeTargetStateMachineParameters)
- newPipeTargetParameters :: PipeTargetParameters
- data PipeTargetRedshiftDataParameters = PipeTargetRedshiftDataParameters' (Maybe (Sensitive Text)) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Bool) (Sensitive Text) (NonEmpty (Sensitive Text))
- newPipeTargetRedshiftDataParameters :: Text -> NonEmpty Text -> PipeTargetRedshiftDataParameters
- data PipeTargetSageMakerPipelineParameters = PipeTargetSageMakerPipelineParameters' (Maybe [SageMakerPipelineParameter])
- newPipeTargetSageMakerPipelineParameters :: PipeTargetSageMakerPipelineParameters
- data PipeTargetSqsQueueParameters = PipeTargetSqsQueueParameters' (Maybe (Sensitive Text)) (Maybe (Sensitive Text))
- newPipeTargetSqsQueueParameters :: PipeTargetSqsQueueParameters
- data PipeTargetStateMachineParameters = PipeTargetStateMachineParameters' (Maybe PipeTargetInvocationType)
- newPipeTargetStateMachineParameters :: PipeTargetStateMachineParameters
- data PlacementConstraint = PlacementConstraint' (Maybe (Sensitive Text)) (Maybe PlacementConstraintType)
- newPlacementConstraint :: PlacementConstraint
- data PlacementStrategy = PlacementStrategy' (Maybe (Sensitive Text)) (Maybe PlacementStrategyType)
- newPlacementStrategy :: PlacementStrategy
- data SageMakerPipelineParameter = SageMakerPipelineParameter' (Sensitive Text) (Sensitive Text)
- newSageMakerPipelineParameter :: Text -> Text -> SageMakerPipelineParameter
- data SelfManagedKafkaAccessConfigurationCredentials = SelfManagedKafkaAccessConfigurationCredentials' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newSelfManagedKafkaAccessConfigurationCredentials :: SelfManagedKafkaAccessConfigurationCredentials
- data SelfManagedKafkaAccessConfigurationVpc = SelfManagedKafkaAccessConfigurationVpc' (Maybe [Sensitive Text]) (Maybe [Sensitive Text])
- newSelfManagedKafkaAccessConfigurationVpc :: SelfManagedKafkaAccessConfigurationVpc
- data Tag = Tag' Text (Sensitive Text)
- newTag :: Text -> Text -> Tag
- data UpdatePipeSourceActiveMQBrokerParameters = UpdatePipeSourceActiveMQBrokerParameters' (Maybe Natural) (Maybe Natural) MQBrokerAccessCredentials
- newUpdatePipeSourceActiveMQBrokerParameters :: MQBrokerAccessCredentials -> UpdatePipeSourceActiveMQBrokerParameters
- data UpdatePipeSourceDynamoDBStreamParameters = UpdatePipeSourceDynamoDBStreamParameters' (Maybe Natural) (Maybe DeadLetterConfig) (Maybe Natural) (Maybe Int) (Maybe Int) (Maybe OnPartialBatchItemFailureStreams) (Maybe Natural)
- newUpdatePipeSourceDynamoDBStreamParameters :: UpdatePipeSourceDynamoDBStreamParameters
- data UpdatePipeSourceKinesisStreamParameters = UpdatePipeSourceKinesisStreamParameters' (Maybe Natural) (Maybe DeadLetterConfig) (Maybe Natural) (Maybe Int) (Maybe Int) (Maybe OnPartialBatchItemFailureStreams) (Maybe Natural)
- newUpdatePipeSourceKinesisStreamParameters :: UpdatePipeSourceKinesisStreamParameters
- data UpdatePipeSourceManagedStreamingKafkaParameters = UpdatePipeSourceManagedStreamingKafkaParameters' (Maybe Natural) (Maybe MSKAccessCredentials) (Maybe Natural)
- newUpdatePipeSourceManagedStreamingKafkaParameters :: UpdatePipeSourceManagedStreamingKafkaParameters
- data UpdatePipeSourceParameters = UpdatePipeSourceParameters' (Maybe UpdatePipeSourceActiveMQBrokerParameters) (Maybe UpdatePipeSourceDynamoDBStreamParameters) (Maybe FilterCriteria) (Maybe UpdatePipeSourceKinesisStreamParameters) (Maybe UpdatePipeSourceManagedStreamingKafkaParameters) (Maybe UpdatePipeSourceRabbitMQBrokerParameters) (Maybe UpdatePipeSourceSelfManagedKafkaParameters) (Maybe UpdatePipeSourceSqsQueueParameters)
- newUpdatePipeSourceParameters :: UpdatePipeSourceParameters
- data UpdatePipeSourceRabbitMQBrokerParameters = UpdatePipeSourceRabbitMQBrokerParameters' (Maybe Natural) (Maybe Natural) MQBrokerAccessCredentials
- newUpdatePipeSourceRabbitMQBrokerParameters :: MQBrokerAccessCredentials -> UpdatePipeSourceRabbitMQBrokerParameters
- data UpdatePipeSourceSelfManagedKafkaParameters = UpdatePipeSourceSelfManagedKafkaParameters' (Maybe Natural) (Maybe SelfManagedKafkaAccessConfigurationCredentials) (Maybe Natural) (Maybe Text) (Maybe SelfManagedKafkaAccessConfigurationVpc)
- newUpdatePipeSourceSelfManagedKafkaParameters :: UpdatePipeSourceSelfManagedKafkaParameters
- data UpdatePipeSourceSqsQueueParameters = UpdatePipeSourceSqsQueueParameters' (Maybe Natural) (Maybe Natural)
- newUpdatePipeSourceSqsQueueParameters :: UpdatePipeSourceSqsQueueParameters
Service Configuration
defaultService :: Service Source #
API version 2015-10-07 of the Amazon EventBridge Pipes SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Pipes.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
An action you attempted resulted in an exception.
InternalException
_InternalException :: AsError a => Fold a ServiceError Source #
This exception occurs due to unexpected causes.
NotFoundException
_NotFoundException :: AsError a => Fold a ServiceError Source #
An entity that you specified does not exist.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
A quota has been exceeded.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
An action was throttled.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
Indicates that an error has occurred while performing a validate operation.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreatePipe
data CreatePipe Source #
See: newCreatePipe smart constructor.
Constructors
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> 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.
data CreatePipeResponse Source #
See: newCreatePipeResponse smart constructor.
Constructors
| CreatePipeResponse' (Maybe Text) (Maybe POSIX) (Maybe PipeState) (Maybe RequestedPipeState) (Maybe POSIX) (Maybe Text) Int |
Instances
newCreatePipeResponse Source #
Arguments
| :: Int | |
| -> 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.
DeletePipe
data DeletePipe Source #
See: newDeletePipe smart constructor.
Constructors
| DeletePipe' Text |
Instances
Arguments
| :: Text | |
| -> DeletePipe |
Create a value of DeletePipe 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:
DeletePipe, deletePipe_name - The name of the pipe.
data DeletePipeResponse Source #
See: newDeletePipeResponse smart constructor.
Constructors
| DeletePipeResponse' (Maybe Text) (Maybe POSIX) (Maybe PipeState) (Maybe RequestedPipeStateDescribeResponse) (Maybe POSIX) (Maybe Text) Int |
Instances
newDeletePipeResponse Source #
Arguments
| :: Int | |
| -> DeletePipeResponse |
Create a value of DeletePipeResponse 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:
DeletePipeResponse, deletePipeResponse_arn - The ARN of the pipe.
DeletePipeResponse, deletePipeResponse_creationTime - The time the pipe was created.
DeletePipeResponse, deletePipeResponse_currentState - The state the pipe is in.
DeletePipeResponse, deletePipeResponse_desiredState - The state the pipe should be in.
DeletePipeResponse, deletePipeResponse_lastModifiedTime - When the pipe was last updated, in
ISO-8601 format
(YYYY-MM-DDThh:mm:ss.sTZD).
DeletePipe, deletePipeResponse_name - The name of the pipe.
$sel:httpStatus:DeletePipeResponse', deletePipeResponse_httpStatus - The response's http status code.
DescribePipe
data DescribePipe Source #
See: newDescribePipe smart constructor.
Constructors
| DescribePipe' Text |
Instances
Arguments
| :: Text | |
| -> DescribePipe |
Create a value of DescribePipe 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:
DescribePipe, describePipe_name - The name of the pipe.
data DescribePipeResponse Source #
See: newDescribePipeResponse smart constructor.
Constructors
| DescribePipeResponse' (Maybe Text) (Maybe POSIX) (Maybe PipeState) (Maybe (Sensitive Text)) (Maybe RequestedPipeStateDescribeResponse) (Maybe Text) (Maybe PipeEnrichmentParameters) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe PipeSourceParameters) (Maybe Text) (Maybe (HashMap Text (Sensitive Text))) (Maybe Text) (Maybe PipeTargetParameters) Int |
Instances
newDescribePipeResponse Source #
Arguments
| :: Int | |
| -> DescribePipeResponse |
Create a value of DescribePipeResponse 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:
DescribePipeResponse, describePipeResponse_arn - The ARN of the pipe.
DescribePipeResponse, describePipeResponse_creationTime - The time the pipe was created.
DescribePipeResponse, describePipeResponse_currentState - The state the pipe is in.
$sel:description:DescribePipeResponse', describePipeResponse_description - A description of the pipe.
DescribePipeResponse, describePipeResponse_desiredState - The state the pipe should be in.
DescribePipeResponse, describePipeResponse_enrichment - The ARN of the enrichment resource.
$sel:enrichmentParameters:DescribePipeResponse', describePipeResponse_enrichmentParameters - The parameters required to set up enrichment on your pipe.
DescribePipeResponse, describePipeResponse_lastModifiedTime - When the pipe was last updated, in
ISO-8601 format
(YYYY-MM-DDThh:mm:ss.sTZD).
DescribePipe, describePipeResponse_name - The name of the pipe.
$sel:roleArn:DescribePipeResponse', describePipeResponse_roleArn - The ARN of the role that allows the pipe to send data to the target.
DescribePipeResponse, describePipeResponse_source - The ARN of the source resource.
$sel:sourceParameters:DescribePipeResponse', describePipeResponse_sourceParameters - The parameters required to set up a source for your pipe.
DescribePipeResponse, describePipeResponse_stateReason - The reason the pipe is in its current state.
DescribePipeResponse, describePipeResponse_tags - The list of key-value pairs to associate with the pipe.
DescribePipeResponse, describePipeResponse_target - The ARN of the target resource.
$sel:targetParameters:DescribePipeResponse', describePipeResponse_targetParameters - The parameters required to set up a target for your pipe.
$sel:httpStatus:DescribePipeResponse', describePipeResponse_httpStatus - The response's http status code.
ListPipes (Paginated)
See: newListPipes smart constructor.
Constructors
| ListPipes' (Maybe PipeState) (Maybe RequestedPipeState) (Maybe Natural) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) |
Instances
newListPipes :: ListPipes Source #
Create a value of ListPipes 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:
ListPipes, listPipes_currentState - The state the pipe is in.
ListPipes, listPipes_desiredState - The state the pipe should be in.
$sel:limit:ListPipes', listPipes_limit - The maximum number of pipes to include in the response.
$sel:namePrefix:ListPipes', listPipes_namePrefix - A value that will return a subset of the pipes associated with this
account. For example, "NamePrefix": "ABC" will return all
endpoints with "ABC" in the name.
ListPipes, listPipes_nextToken - If nextToken is returned, there are more results available. The value
of nextToken is a unique pagination token for each page. Make the call
again using the returned token to retrieve the next page. Keep all other
arguments unchanged. Each pagination token expires after 24 hours. Using
an expired pagination token will return an HTTP 400 InvalidToken error.
$sel:sourcePrefix:ListPipes', listPipes_sourcePrefix - The prefix matching the pipe source.
$sel:targetPrefix:ListPipes', listPipes_targetPrefix - The prefix matching the pipe target.
data ListPipesResponse Source #
See: newListPipesResponse smart constructor.
Instances
Arguments
| :: Int | |
| -> ListPipesResponse |
Create a value of ListPipesResponse 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:
ListPipes, listPipesResponse_nextToken - If nextToken is returned, there are more results available. The value
of nextToken is a unique pagination token for each page. Make the call
again using the returned token to retrieve the next page. Keep all other
arguments unchanged. Each pagination token expires after 24 hours. Using
an expired pagination token will return an HTTP 400 InvalidToken error.
$sel:pipes:ListPipesResponse', listPipesResponse_pipes - The pipes returned by the call.
$sel:httpStatus:ListPipesResponse', listPipesResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The ARN of the pipe for which you want to view tags.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:
ListTagsForResourceResponse, listTagsForResourceResponse_tags - The list of key-value pairs to associate with the pipe.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
StartPipe
See: newStartPipe smart constructor.
Constructors
| StartPipe' Text |
Instances
Create a value of StartPipe 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:
StartPipe, startPipe_name - The name of the pipe.
data StartPipeResponse Source #
See: newStartPipeResponse smart constructor.
Constructors
| StartPipeResponse' (Maybe Text) (Maybe POSIX) (Maybe PipeState) (Maybe RequestedPipeState) (Maybe POSIX) (Maybe Text) Int |
Instances
Arguments
| :: Int | |
| -> StartPipeResponse |
Create a value of StartPipeResponse 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:
StartPipeResponse, startPipeResponse_arn - The ARN of the pipe.
StartPipeResponse, startPipeResponse_creationTime - The time the pipe was created.
StartPipeResponse, startPipeResponse_currentState - The state the pipe is in.
StartPipeResponse, startPipeResponse_desiredState - The state the pipe should be in.
StartPipeResponse, startPipeResponse_lastModifiedTime - When the pipe was last updated, in
ISO-8601 format
(YYYY-MM-DDThh:mm:ss.sTZD).
StartPipe, startPipeResponse_name - The name of the pipe.
$sel:httpStatus:StartPipeResponse', startPipeResponse_httpStatus - The response's http status code.
StopPipe
See: newStopPipe smart constructor.
Instances
Create a value of StopPipe 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:
StopPipe, stopPipe_name - The name of the pipe.
data StopPipeResponse Source #
See: newStopPipeResponse smart constructor.
Constructors
| StopPipeResponse' (Maybe Text) (Maybe POSIX) (Maybe PipeState) (Maybe RequestedPipeState) (Maybe POSIX) (Maybe Text) Int |
Instances
Arguments
| :: Int | |
| -> StopPipeResponse |
Create a value of StopPipeResponse 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:
StopPipeResponse, stopPipeResponse_arn - The ARN of the pipe.
StopPipeResponse, stopPipeResponse_creationTime - The time the pipe was created.
StopPipeResponse, stopPipeResponse_currentState - The state the pipe is in.
StopPipeResponse, stopPipeResponse_desiredState - The state the pipe should be in.
StopPipeResponse, stopPipeResponse_lastModifiedTime - When the pipe was last updated, in
ISO-8601 format
(YYYY-MM-DDThh:mm:ss.sTZD).
StopPipe, stopPipeResponse_name - The name of the pipe.
$sel:httpStatus:StopPipeResponse', stopPipeResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:resourceArn:TagResource', tagResource_resourceArn - The ARN of the pipe.
TagResource, tagResource_tags - The list of key-value pairs associated with the pipe.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource 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:resourceArn:UntagResource', untagResource_resourceArn - The ARN of the pipe.
$sel:tagKeys:UntagResource', untagResource_tagKeys - The list of tag keys to remove from the pipe.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdatePipe
data UpdatePipe Source #
See: newUpdatePipe smart constructor.
Constructors
| UpdatePipe' (Maybe (Sensitive Text)) (Maybe RequestedPipeState) (Maybe Text) (Maybe PipeEnrichmentParameters) (Maybe UpdatePipeSourceParameters) (Maybe Text) (Maybe PipeTargetParameters) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UpdatePipe |
Create a value of UpdatePipe 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:UpdatePipe', updatePipe_description - A description of the pipe.
UpdatePipe, updatePipe_desiredState - The state the pipe should be in.
UpdatePipe, updatePipe_enrichment - The ARN of the enrichment resource.
$sel:enrichmentParameters:UpdatePipe', updatePipe_enrichmentParameters - The parameters required to set up enrichment on your pipe.
$sel:sourceParameters:UpdatePipe', updatePipe_sourceParameters - The parameters required to set up a source for your pipe.
UpdatePipe, updatePipe_target - The ARN of the target resource.
$sel:targetParameters:UpdatePipe', updatePipe_targetParameters - The parameters required to set up a target for your pipe.
UpdatePipe, updatePipe_name - The name of the pipe.
$sel:roleArn:UpdatePipe', updatePipe_roleArn - The ARN of the role that allows the pipe to send data to the target.
data UpdatePipeResponse Source #
See: newUpdatePipeResponse smart constructor.
Constructors
| UpdatePipeResponse' (Maybe Text) (Maybe POSIX) (Maybe PipeState) (Maybe RequestedPipeState) (Maybe POSIX) (Maybe Text) Int |
Instances
newUpdatePipeResponse Source #
Arguments
| :: Int | |
| -> UpdatePipeResponse |
Create a value of UpdatePipeResponse 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:
UpdatePipeResponse, updatePipeResponse_arn - The ARN of the pipe.
UpdatePipeResponse, updatePipeResponse_creationTime - The time the pipe was created.
UpdatePipeResponse, updatePipeResponse_currentState - The state the pipe is in.
UpdatePipe, updatePipeResponse_desiredState - The state the pipe should be in.
UpdatePipeResponse, updatePipeResponse_lastModifiedTime - When the pipe was last updated, in
ISO-8601 format
(YYYY-MM-DDThh:mm:ss.sTZD).
UpdatePipe, updatePipeResponse_name - The name of the pipe.
$sel:httpStatus:UpdatePipeResponse', updatePipeResponse_httpStatus - The response's http status code.
Types
AssignPublicIp
newtype AssignPublicIp Source #
Constructors
| AssignPublicIp' | |
Fields | |
Bundled Patterns
| pattern AssignPublicIp_DISABLED :: AssignPublicIp | |
| pattern AssignPublicIp_ENABLED :: AssignPublicIp |
Instances
BatchJobDependencyType
newtype BatchJobDependencyType Source #
Constructors
| BatchJobDependencyType' | |
Fields | |
Bundled Patterns
| pattern BatchJobDependencyType_N_TO_N :: BatchJobDependencyType | |
| pattern BatchJobDependencyType_SEQUENTIAL :: BatchJobDependencyType |
Instances
BatchResourceRequirementType
newtype BatchResourceRequirementType Source #
Constructors
| BatchResourceRequirementType' | |
Fields | |
Bundled Patterns
Instances
DynamoDBStreamStartPosition
newtype DynamoDBStreamStartPosition Source #
Constructors
| DynamoDBStreamStartPosition' | |
Fields | |
Bundled Patterns
| pattern DynamoDBStreamStartPosition_LATEST :: DynamoDBStreamStartPosition | |
| pattern DynamoDBStreamStartPosition_TRIM_HORIZON :: DynamoDBStreamStartPosition |
Instances
EcsEnvironmentFileType
newtype EcsEnvironmentFileType Source #
Constructors
| EcsEnvironmentFileType' | |
Fields | |
Bundled Patterns
| pattern EcsEnvironmentFileType_S3 :: EcsEnvironmentFileType |
Instances
EcsResourceRequirementType
newtype EcsResourceRequirementType Source #
Constructors
| EcsResourceRequirementType' | |
Fields | |
Bundled Patterns
| pattern EcsResourceRequirementType_GPU :: EcsResourceRequirementType | |
| pattern EcsResourceRequirementType_InferenceAccelerator :: EcsResourceRequirementType |
Instances
KinesisStreamStartPosition
newtype KinesisStreamStartPosition Source #
Constructors
| KinesisStreamStartPosition' | |
Fields | |
Bundled Patterns
Instances
LaunchType
newtype LaunchType Source #
Constructors
| LaunchType' | |
Fields | |
Bundled Patterns
| pattern LaunchType_EC2 :: LaunchType | |
| pattern LaunchType_EXTERNAL :: LaunchType | |
| pattern LaunchType_FARGATE :: LaunchType |
Instances
MSKStartPosition
newtype MSKStartPosition Source #
Constructors
| MSKStartPosition' | |
Fields | |
Bundled Patterns
| pattern MSKStartPosition_LATEST :: MSKStartPosition | |
| pattern MSKStartPosition_TRIM_HORIZON :: MSKStartPosition |
Instances
OnPartialBatchItemFailureStreams
newtype OnPartialBatchItemFailureStreams Source #
Constructors
| OnPartialBatchItemFailureStreams' | |
Fields | |
Bundled Patterns
| pattern OnPartialBatchItemFailureStreams_AUTOMATIC_BISECT :: OnPartialBatchItemFailureStreams |
Instances
PipeState
Constructors
| PipeState' | |
Fields | |
Bundled Patterns
| pattern PipeState_CREATE_FAILED :: PipeState | |
| pattern PipeState_CREATING :: PipeState | |
| pattern PipeState_DELETING :: PipeState | |
| pattern PipeState_RUNNING :: PipeState | |
| pattern PipeState_STARTING :: PipeState | |
| pattern PipeState_START_FAILED :: PipeState | |
| pattern PipeState_STOPPED :: PipeState | |
| pattern PipeState_STOPPING :: PipeState | |
| pattern PipeState_STOP_FAILED :: PipeState | |
| pattern PipeState_UPDATE_FAILED :: PipeState | |
| pattern PipeState_UPDATING :: PipeState |
Instances
PipeTargetInvocationType
newtype PipeTargetInvocationType Source #
Constructors
| PipeTargetInvocationType' | |
Fields | |
Bundled Patterns
| pattern PipeTargetInvocationType_FIRE_AND_FORGET :: PipeTargetInvocationType | |
| pattern PipeTargetInvocationType_REQUEST_RESPONSE :: PipeTargetInvocationType |
Instances
PlacementConstraintType
newtype PlacementConstraintType Source #
Constructors
| PlacementConstraintType' | |
Fields | |
Bundled Patterns
| pattern PlacementConstraintType_DistinctInstance :: PlacementConstraintType | |
| pattern PlacementConstraintType_MemberOf :: PlacementConstraintType |
Instances
PlacementStrategyType
newtype PlacementStrategyType Source #
Constructors
| PlacementStrategyType' | |
Fields | |
Bundled Patterns
| pattern PlacementStrategyType_Binpack :: PlacementStrategyType | |
| pattern PlacementStrategyType_Random :: PlacementStrategyType | |
| pattern PlacementStrategyType_Spread :: PlacementStrategyType |
Instances
PropagateTags
newtype PropagateTags Source #
Constructors
| PropagateTags' | |
Fields | |
Bundled Patterns
| pattern PropagateTags_TASK_DEFINITION :: PropagateTags |
Instances
RequestedPipeState
newtype RequestedPipeState Source #
Constructors
| RequestedPipeState' | |
Fields | |
Bundled Patterns
| pattern RequestedPipeState_RUNNING :: RequestedPipeState | |
| pattern RequestedPipeState_STOPPED :: RequestedPipeState |
Instances
RequestedPipeStateDescribeResponse
newtype RequestedPipeStateDescribeResponse Source #
Constructors
| RequestedPipeStateDescribeResponse' | |
Bundled Patterns
Instances
SelfManagedKafkaStartPosition
newtype SelfManagedKafkaStartPosition Source #
Constructors
| SelfManagedKafkaStartPosition' | |
Fields | |
Bundled Patterns
| pattern SelfManagedKafkaStartPosition_LATEST :: SelfManagedKafkaStartPosition | |
| pattern SelfManagedKafkaStartPosition_TRIM_HORIZON :: SelfManagedKafkaStartPosition |
Instances
AwsVpcConfiguration
data AwsVpcConfiguration Source #
This structure specifies the VPC subnets and security groups for the
task, and whether a public IP address is to be used. This structure is
relevant only for ECS tasks that use the awsvpc network mode.
See: newAwsVpcConfiguration smart constructor.
Constructors
| AwsVpcConfiguration' (Maybe AssignPublicIp) (Maybe [Sensitive Text]) [Sensitive Text] |
Instances
newAwsVpcConfiguration :: AwsVpcConfiguration Source #
Create a value of AwsVpcConfiguration 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:assignPublicIp:AwsVpcConfiguration', awsVpcConfiguration_assignPublicIp - Specifies whether the task's elastic network interface receives a
public IP address. You can specify ENABLED only when LaunchType in
EcsParameters is set to FARGATE.
$sel:securityGroups:AwsVpcConfiguration', awsVpcConfiguration_securityGroups - Specifies the security groups associated with the task. These security
groups must all be in the same VPC. You can specify as many as five
security groups. If you do not specify a security group, the default
security group for the VPC is used.
$sel:subnets:AwsVpcConfiguration', awsVpcConfiguration_subnets - Specifies the subnets associated with the task. These subnets must all
be in the same VPC. You can specify as many as 16 subnets.
BatchArrayProperties
data BatchArrayProperties Source #
The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.
See: newBatchArrayProperties smart constructor.
Constructors
| BatchArrayProperties' (Maybe Natural) |
Instances
newBatchArrayProperties :: BatchArrayProperties Source #
Create a value of BatchArrayProperties 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:size:BatchArrayProperties', batchArrayProperties_size - The size of the array, if this is an array batch job.
BatchContainerOverrides
data BatchContainerOverrides Source #
The overrides that are sent to a container.
See: newBatchContainerOverrides smart constructor.
Constructors
| BatchContainerOverrides' (Maybe [Text]) (Maybe [BatchEnvironmentVariable]) (Maybe Text) (Maybe [BatchResourceRequirement]) |
Instances
newBatchContainerOverrides :: BatchContainerOverrides Source #
Create a value of BatchContainerOverrides 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:command:BatchContainerOverrides', batchContainerOverrides_command - The command to send to the container that overrides the default command
from the Docker image or the task definition.
$sel:environment:BatchContainerOverrides', batchContainerOverrides_environment - The environment variables to send to the container. You can add new
environment variables, which are added to the container at launch, or
you can override the existing environment variables from the Docker
image or the task definition.
Environment variables cannot start with "Batch". This naming
convention is reserved for variables that Batch sets.
$sel:instanceType:BatchContainerOverrides', batchContainerOverrides_instanceType - The instance type to use for a multi-node parallel job.
This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
$sel:resourceRequirements:BatchContainerOverrides', batchContainerOverrides_resourceRequirements - The type and amount of resources to assign to a container. This
overrides the settings in the job definition. The supported resources
include GPU, MEMORY, and VCPU.
BatchEnvironmentVariable
data BatchEnvironmentVariable Source #
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition.
Environment variables cannot start with "Batch". This naming
convention is reserved for variables that Batch sets.
See: newBatchEnvironmentVariable smart constructor.
Constructors
| BatchEnvironmentVariable' (Maybe Text) (Maybe Text) |
Instances
newBatchEnvironmentVariable :: BatchEnvironmentVariable Source #
Create a value of BatchEnvironmentVariable 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:name:BatchEnvironmentVariable', batchEnvironmentVariable_name - The name of the key-value pair. For environment variables, this is the
name of the environment variable.
$sel:value:BatchEnvironmentVariable', batchEnvironmentVariable_value - The value of the key-value pair. For environment variables, this is the
value of the environment variable.
BatchJobDependency
data BatchJobDependency Source #
An object that represents an Batch job dependency.
See: newBatchJobDependency smart constructor.
Constructors
| BatchJobDependency' (Maybe Text) (Maybe BatchJobDependencyType) |
Instances
newBatchJobDependency :: BatchJobDependency Source #
Create a value of BatchJobDependency 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:jobId:BatchJobDependency', batchJobDependency_jobId - The job ID of the Batch job that's associated with this dependency.
$sel:type':BatchJobDependency', batchJobDependency_type - The type of the job dependency.
BatchResourceRequirement
data BatchResourceRequirement Source #
The type and amount of a resource to assign to a container. The
supported resources include GPU, MEMORY, and VCPU.
See: newBatchResourceRequirement smart constructor.
Instances
newBatchResourceRequirement Source #
Arguments
| :: BatchResourceRequirementType | |
| -> Text | |
| -> BatchResourceRequirement |
Create a value of BatchResourceRequirement 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:type':BatchResourceRequirement', batchResourceRequirement_type - The type of resource to assign to a container. The supported resources
include GPU, MEMORY, and VCPU.
$sel:value:BatchResourceRequirement', batchResourceRequirement_value - The quantity of the specified resource to reserve for the container. The
values vary based on the type specified.
- type="GPU"
- The number of physical GPUs to reserve for the container. Make sure
that the number of GPUs reserved for all containers in a job
doesn't exceed the number of available GPUs on the compute resource
that the job is launched on.
GPUs aren't available for jobs that are running on Fargate resources.
- type="MEMORY"
- The memory hard limit (in MiB) present to the container. This
parameter is supported for jobs that are running on EC2 resources.
If your container attempts to exceed the memory specified, the
container is terminated. This parameter maps to
Memoryin the Create a container section of the Docker Remote API and the--memoryoption to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps toMemoryin the Create a container section of the Docker Remote API and the--memoryoption to docker run.If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory management in the Batch User Guide.
For jobs that are running on Fargate resources, then
valueis the hard limit (in MiB), and must match one of the supported values and theVCPUvalues must be one of the values supported for that memory value.- value = 512
VCPU= 0.25- value = 1024
VCPU= 0.25 or 0.5- value = 2048
VCPU= 0.25, 0.5, or 1- value = 3072
VCPU= 0.5, or 1- value = 4096
VCPU= 0.5, 1, or 2- value = 5120, 6144, or 7168
VCPU= 1 or 2- value = 8192
VCPU= 1, 2, 4, or 8- value = 9216, 10240, 11264, 12288, 13312, 14336, or 15360
VCPU= 2 or 4- value = 16384
VCPU= 2, 4, or 8- value = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, 27648, 29696, or 30720
VCPU= 4- value = 20480, 24576, or 28672
VCPU= 4 or 8- value = 36864, 45056, 53248, or 61440
VCPU= 8- value = 32768, 40960, 49152, or 57344
VCPU= 8 or 16- value = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880
VCPU= 16
- type="VCPU"
- The number of vCPUs reserved for the container. This parameter maps
to
CpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption to docker run. Each vCPU is equivalent to 1,024 CPU shares. For EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about Fargate quotas, see Fargate quotas in the Amazon Web Services General Reference.
For jobs that are running on Fargate resources, then
valuemust match one of the supported values and theMEMORYvalues must be one of the values supported for thatVCPUvalue. The supported values are 0.25, 0.5, 1, 2, 4, 8, and 16- value = 0.25
MEMORY= 512, 1024, or 2048- value = 0.5
MEMORY= 1024, 2048, 3072, or 4096- value = 1
MEMORY= 2048, 3072, 4096, 5120, 6144, 7168, or 8192- value = 2
MEMORY= 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384- value = 4
MEMORY= 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720- value = 8
MEMORY= 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440- value = 16
MEMORY= 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880
BatchRetryStrategy
data BatchRetryStrategy Source #
The retry strategy that's associated with a job. For more information, see Automated job retries in the Batch User Guide.
See: newBatchRetryStrategy smart constructor.
Constructors
| BatchRetryStrategy' (Maybe Natural) |
Instances
newBatchRetryStrategy :: BatchRetryStrategy Source #
Create a value of BatchRetryStrategy 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:attempts:BatchRetryStrategy', batchRetryStrategy_attempts - The number of times to move a job to the RUNNABLE status. If the value
of attempts is greater than one, the job is retried on failure the
same number of attempts as the value.
CapacityProviderStrategyItem
data CapacityProviderStrategyItem Source #
The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem in the Amazon ECS API Reference.
See: newCapacityProviderStrategyItem smart constructor.
Instances
newCapacityProviderStrategyItem Source #
Create a value of CapacityProviderStrategyItem 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:base:CapacityProviderStrategyItem', capacityProviderStrategyItem_base - The base value designates how many tasks, at a minimum, to run on the
specified capacity provider. Only one capacity provider in a capacity
provider strategy can have a base defined. If no value is specified, the
default value of 0 is used.
$sel:weight:CapacityProviderStrategyItem', capacityProviderStrategyItem_weight - The weight value designates the relative percentage of the total number
of tasks launched that should use the specified capacity provider. The
weight value is taken into consideration after the base value, if
defined, is satisfied.
$sel:capacityProvider:CapacityProviderStrategyItem', capacityProviderStrategyItem_capacityProvider - The short name of the capacity provider.
DeadLetterConfig
data DeadLetterConfig Source #
A DeadLetterConfig object that contains information about a
dead-letter queue configuration.
See: newDeadLetterConfig smart constructor.
Constructors
| DeadLetterConfig' (Maybe Text) |
Instances
newDeadLetterConfig :: DeadLetterConfig Source #
Create a value of DeadLetterConfig 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:arn:DeadLetterConfig', deadLetterConfig_arn - The ARN of the Amazon SQS queue specified as the target for the
dead-letter queue.
EcsContainerOverride
data EcsContainerOverride Source #
The overrides that are sent to a container. An empty container override
can be passed in. An example of an empty container override is
{"containerOverrides": [ ] }. If a non-empty container override is
specified, the name parameter must be included.
See: newEcsContainerOverride smart constructor.
Constructors
| EcsContainerOverride' (Maybe [Text]) (Maybe Int) (Maybe [EcsEnvironmentVariable]) (Maybe [EcsEnvironmentFile]) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe [EcsResourceRequirement]) |
Instances
newEcsContainerOverride :: EcsContainerOverride Source #
Create a value of EcsContainerOverride 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:command:EcsContainerOverride', ecsContainerOverride_command - The command to send to the container that overrides the default command
from the Docker image or the task definition. You must also specify a
container name.
$sel:cpu:EcsContainerOverride', ecsContainerOverride_cpu - The number of cpu units reserved for the container, instead of the
default value from the task definition. You must also specify a
container name.
$sel:environment:EcsContainerOverride', ecsContainerOverride_environment - The environment variables to send to the container. You can add new
environment variables, which are added to the container at launch, or
you can override the existing environment variables from the Docker
image or the task definition. You must also specify a container name.
$sel:environmentFiles:EcsContainerOverride', ecsContainerOverride_environmentFiles - A list of files containing the environment variables to pass to a
container, instead of the value from the container definition.
$sel:memory:EcsContainerOverride', ecsContainerOverride_memory - The hard limit (in MiB) of memory to present to the container, instead
of the default value from the task definition. If your container
attempts to exceed the memory specified here, the container is killed.
You must also specify a container name.
$sel:memoryReservation:EcsContainerOverride', ecsContainerOverride_memoryReservation - The soft limit (in MiB) of memory to reserve for the container, instead
of the default value from the task definition. You must also specify a
container name.
EcsContainerOverride, ecsContainerOverride_name - The name of the container that receives the override. This parameter is
required if any override is specified.
$sel:resourceRequirements:EcsContainerOverride', ecsContainerOverride_resourceRequirements - The type and amount of a resource to assign to a container, instead of
the default value from the task definition. The only supported resource
is a GPU.
EcsEnvironmentFile
data EcsEnvironmentFile Source #
A list of files containing the environment variables to pass to a
container. You can specify up to ten environment files. The file must
have a .env file extension. Each line in an environment file should
contain an environment variable in VARIABLE=VALUE format. Lines
beginning with # are treated as comments and are ignored. For more
information about the environment variable file syntax, see
Declare default environment variables in file.
If there are environment variables specified using the environment
parameter in a container definition, they take precedence over the
variables contained within an environment file. If multiple environment
files are specified that contain the same variable, they're processed
from the top down. We recommend that you use unique variable names. For
more information, see
Specifying environment variables
in the Amazon Elastic Container Service Developer Guide.
This parameter is only supported for tasks hosted on Fargate using the following platform versions:
- Linux platform version
1.4.0or later. - Windows platform version
1.0.0or later.
See: newEcsEnvironmentFile smart constructor.
Constructors
| EcsEnvironmentFile' EcsEnvironmentFileType Text |
Instances
newEcsEnvironmentFile Source #
Arguments
| :: EcsEnvironmentFileType | |
| -> Text | |
| -> EcsEnvironmentFile |
Create a value of EcsEnvironmentFile 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:type':EcsEnvironmentFile', ecsEnvironmentFile_type - The file type to use. The only supported value is s3.
$sel:value:EcsEnvironmentFile', ecsEnvironmentFile_value - The Amazon Resource Name (ARN) of the Amazon S3 object containing the
environment variable file.
EcsEnvironmentVariable
data EcsEnvironmentVariable Source #
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
See: newEcsEnvironmentVariable smart constructor.
Constructors
| EcsEnvironmentVariable' (Maybe Text) (Maybe Text) |
Instances
newEcsEnvironmentVariable :: EcsEnvironmentVariable Source #
Create a value of EcsEnvironmentVariable 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:name:EcsEnvironmentVariable', ecsEnvironmentVariable_name - The name of the key-value pair. For environment variables, this is the
name of the environment variable.
$sel:value:EcsEnvironmentVariable', ecsEnvironmentVariable_value - The value of the key-value pair. For environment variables, this is the
value of the environment variable.
EcsEphemeralStorage
data EcsEphemeralStorage Source #
The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Fargate task storage in the Amazon ECS User Guide for Fargate.
This parameter is only supported for tasks hosted on Fargate using Linux
platform version 1.4.0 or later. This parameter is not supported for
Windows containers on Fargate.
See: newEcsEphemeralStorage smart constructor.
Constructors
| EcsEphemeralStorage' Natural |
Instances
newEcsEphemeralStorage Source #
Create a value of EcsEphemeralStorage 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:sizeInGiB:EcsEphemeralStorage', ecsEphemeralStorage_sizeInGiB - The total amount, in GiB, of ephemeral storage to set for the task. The
minimum supported value is 21 GiB and the maximum supported value is
200 GiB.
EcsInferenceAcceleratorOverride
data EcsInferenceAcceleratorOverride Source #
Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
See: newEcsInferenceAcceleratorOverride smart constructor.
Constructors
| EcsInferenceAcceleratorOverride' (Maybe Text) (Maybe Text) |
Instances
newEcsInferenceAcceleratorOverride :: EcsInferenceAcceleratorOverride Source #
Create a value of EcsInferenceAcceleratorOverride 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:deviceName:EcsInferenceAcceleratorOverride', ecsInferenceAcceleratorOverride_deviceName - The Elastic Inference accelerator device name to override for the task.
This parameter must match a deviceName specified in the task
definition.
$sel:deviceType:EcsInferenceAcceleratorOverride', ecsInferenceAcceleratorOverride_deviceType - The Elastic Inference accelerator type to use.
EcsResourceRequirement
data EcsResourceRequirement Source #
The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide
See: newEcsResourceRequirement smart constructor.
Constructors
| EcsResourceRequirement' EcsResourceRequirementType Text |
Instances
newEcsResourceRequirement Source #
Arguments
| :: EcsResourceRequirementType | |
| -> Text | |
| -> EcsResourceRequirement |
Create a value of EcsResourceRequirement 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:type':EcsResourceRequirement', ecsResourceRequirement_type - The type of resource to assign to a container. The supported values are
GPU or InferenceAccelerator.
$sel:value:EcsResourceRequirement', ecsResourceRequirement_value - The value for the specified resource type.
If the GPU type is used, the value is the number of physical GPUs
the Amazon ECS container agent reserves for the container. The number of
GPUs that's reserved for all containers in a task can't exceed the
number of available GPUs on the container instance that the task is
launched on.
If the InferenceAccelerator type is used, the value matches the
deviceName for an InferenceAccelerator specified in a task definition.
EcsTaskOverride
data EcsTaskOverride Source #
The overrides that are associated with a task.
See: newEcsTaskOverride smart constructor.
Constructors
| EcsTaskOverride' (Maybe [EcsContainerOverride]) (Maybe Text) (Maybe EcsEphemeralStorage) (Maybe Text) (Maybe [EcsInferenceAcceleratorOverride]) (Maybe Text) (Maybe Text) |
Instances
newEcsTaskOverride :: EcsTaskOverride Source #
Create a value of EcsTaskOverride 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:containerOverrides:EcsTaskOverride', ecsTaskOverride_containerOverrides - One or more container overrides that are sent to a task.
EcsTaskOverride, ecsTaskOverride_cpu - The cpu override for the task.
$sel:ephemeralStorage:EcsTaskOverride', ecsTaskOverride_ephemeralStorage - The ephemeral storage setting override for the task.
This parameter is only supported for tasks hosted on Fargate that use the following platform versions:
- Linux platform version
1.4.0or later. - Windows platform version
1.0.0or later.
$sel:executionRoleArn:EcsTaskOverride', ecsTaskOverride_executionRoleArn - The Amazon Resource Name (ARN) of the task execution IAM role override
for the task. For more information, see
Amazon ECS task execution IAM role
in the Amazon Elastic Container Service Developer Guide.
$sel:inferenceAcceleratorOverrides:EcsTaskOverride', ecsTaskOverride_inferenceAcceleratorOverrides - The Elastic Inference accelerator override for the task.
EcsTaskOverride, ecsTaskOverride_memory - The memory override for the task.
$sel:taskRoleArn:EcsTaskOverride', ecsTaskOverride_taskRoleArn - The Amazon Resource Name (ARN) of the IAM role that containers in this
task can assume. All containers in this task are granted the permissions
that are specified in this role. For more information, see
IAM Role for Tasks
in the Amazon Elastic Container Service Developer Guide.
Filter
Filter events using an event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
See: newFilter smart constructor.
Instances
| FromJSON Filter Source # | |
| ToJSON Filter Source # | |
Defined in Amazonka.Pipes.Types.Filter | |
| Generic Filter Source # | |
| Show Filter Source # | |
| NFData Filter Source # | |
Defined in Amazonka.Pipes.Types.Filter | |
| Eq Filter Source # | |
| Hashable Filter Source # | |
Defined in Amazonka.Pipes.Types.Filter | |
| type Rep Filter Source # | |
Defined in Amazonka.Pipes.Types.Filter | |
Create a value of Filter 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:pattern':Filter', filter_pattern - The event pattern.
FilterCriteria
data FilterCriteria Source #
The collection of event patterns used to filter events. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
See: newFilterCriteria smart constructor.
Constructors
| FilterCriteria' (Maybe [Filter]) |
Instances
newFilterCriteria :: FilterCriteria Source #
Create a value of FilterCriteria 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:filters:FilterCriteria', filterCriteria_filters - The event patterns.
MQBrokerAccessCredentials
data MQBrokerAccessCredentials Source #
The Secrets Manager secret that stores your broker credentials.
See: newMQBrokerAccessCredentials smart constructor.
Constructors
| MQBrokerAccessCredentials' (Maybe Text) |
Instances
newMQBrokerAccessCredentials :: MQBrokerAccessCredentials Source #
Create a value of MQBrokerAccessCredentials 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:basicAuth:MQBrokerAccessCredentials', mQBrokerAccessCredentials_basicAuth - The ARN of the Secrets Manager secret.
MSKAccessCredentials
data MSKAccessCredentials Source #
The Secrets Manager secret that stores your stream credentials.
See: newMSKAccessCredentials smart constructor.
Constructors
| MSKAccessCredentials' (Maybe Text) (Maybe Text) |
Instances
newMSKAccessCredentials :: MSKAccessCredentials Source #
Create a value of MSKAccessCredentials 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:clientCertificateTlsAuth:MSKAccessCredentials', mSKAccessCredentials_clientCertificateTlsAuth - The ARN of the Secrets Manager secret.
$sel:saslScram512Auth:MSKAccessCredentials', mSKAccessCredentials_saslScram512Auth - The ARN of the Secrets Manager secret.
NetworkConfiguration
data NetworkConfiguration Source #
This structure specifies the network configuration for an Amazon ECS task.
See: newNetworkConfiguration smart constructor.
Constructors
| NetworkConfiguration' (Maybe AwsVpcConfiguration) |
Instances
newNetworkConfiguration :: NetworkConfiguration Source #
Create a value of NetworkConfiguration 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:awsvpcConfiguration:NetworkConfiguration', networkConfiguration_awsvpcConfiguration - Use this structure to specify the VPC subnets and security groups for
the task, and whether a public IP address is to be used. This structure
is relevant only for ECS tasks that use the awsvpc network mode.
Pipe
An object that represents a pipe. Amazon EventBridgePipes connect event sources to targets and reduces the need for specialized knowledge and integration code.
See: newPipe smart constructor.
Constructors
| Pipe' (Maybe Text) (Maybe POSIX) (Maybe PipeState) (Maybe RequestedPipeState) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
Create a value of Pipe 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:arn:Pipe', pipe_arn - The ARN of the pipe.
$sel:creationTime:Pipe', pipe_creationTime - The time the pipe was created.
$sel:currentState:Pipe', pipe_currentState - The state the pipe is in.
$sel:desiredState:Pipe', pipe_desiredState - The state the pipe should be in.
$sel:enrichment:Pipe', pipe_enrichment - The ARN of the enrichment resource.
$sel:lastModifiedTime:Pipe', pipe_lastModifiedTime - When the pipe was last updated, in
ISO-8601 format
(YYYY-MM-DDThh:mm:ss.sTZD).
$sel:name:Pipe', pipe_name - The name of the pipe.
$sel:source:Pipe', pipe_source - The ARN of the source resource.
$sel:stateReason:Pipe', pipe_stateReason - The reason the pipe is in its current state.
$sel:target:Pipe', pipe_target - The ARN of the target resource.
PipeEnrichmentHttpParameters
data PipeEnrichmentHttpParameters Source #
These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations. In the latter case, these are merged with any InvocationParameters specified on the Connection, with any values from the Connection taking precedence.
See: newPipeEnrichmentHttpParameters smart constructor.
Constructors
| PipeEnrichmentHttpParameters' (Maybe (HashMap Text (Sensitive Text))) (Maybe [Sensitive Text]) (Maybe (HashMap Text (Sensitive Text))) |
Instances
newPipeEnrichmentHttpParameters :: PipeEnrichmentHttpParameters Source #
Create a value of PipeEnrichmentHttpParameters 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:headerParameters:PipeEnrichmentHttpParameters', pipeEnrichmentHttpParameters_headerParameters - The headers that need to be sent as part of request invoking the API
Gateway REST API or EventBridge ApiDestination.
$sel:pathParameterValues:PipeEnrichmentHttpParameters', pipeEnrichmentHttpParameters_pathParameterValues - The path parameter values to be used to populate API Gateway REST API or
EventBridge ApiDestination path wildcards ("*").
$sel:queryStringParameters:PipeEnrichmentHttpParameters', pipeEnrichmentHttpParameters_queryStringParameters - The query string keys/values that need to be sent as part of request
invoking the API Gateway REST API or EventBridge ApiDestination.
PipeEnrichmentParameters
data PipeEnrichmentParameters Source #
The parameters required to set up enrichment on your pipe.
See: newPipeEnrichmentParameters smart constructor.
Constructors
| PipeEnrichmentParameters' (Maybe PipeEnrichmentHttpParameters) (Maybe (Sensitive Text)) |
Instances
newPipeEnrichmentParameters :: PipeEnrichmentParameters Source #
Create a value of PipeEnrichmentParameters 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:httpParameters:PipeEnrichmentParameters', pipeEnrichmentParameters_httpParameters - Contains the HTTP parameters to use when the target is a API Gateway
REST endpoint or EventBridge ApiDestination.
If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.
$sel:inputTemplate:PipeEnrichmentParameters', pipeEnrichmentParameters_inputTemplate - Valid JSON text passed to the enrichment. In this case, nothing from the
event itself is passed to the enrichment. For more information, see
The JavaScript Object Notation (JSON) Data Interchange Format.
PipeSourceActiveMQBrokerParameters
data PipeSourceActiveMQBrokerParameters Source #
The parameters for using an Active MQ broker as a source.
See: newPipeSourceActiveMQBrokerParameters smart constructor.
Constructors
| PipeSourceActiveMQBrokerParameters' (Maybe Natural) (Maybe Natural) MQBrokerAccessCredentials (Sensitive Text) |
Instances
newPipeSourceActiveMQBrokerParameters Source #
Arguments
| :: MQBrokerAccessCredentials | |
| -> Text | |
| -> PipeSourceActiveMQBrokerParameters |
Create a value of PipeSourceActiveMQBrokerParameters 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:batchSize:PipeSourceActiveMQBrokerParameters', pipeSourceActiveMQBrokerParameters_batchSize - The maximum number of records to include in each batch.
$sel:maximumBatchingWindowInSeconds:PipeSourceActiveMQBrokerParameters', pipeSourceActiveMQBrokerParameters_maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.
$sel:credentials:PipeSourceActiveMQBrokerParameters', pipeSourceActiveMQBrokerParameters_credentials - The credentials needed to access the resource.
$sel:queueName:PipeSourceActiveMQBrokerParameters', pipeSourceActiveMQBrokerParameters_queueName - The name of the destination queue to consume.
PipeSourceDynamoDBStreamParameters
data PipeSourceDynamoDBStreamParameters Source #
The parameters for using a DynamoDB stream as a source.
See: newPipeSourceDynamoDBStreamParameters smart constructor.
Constructors
Instances
newPipeSourceDynamoDBStreamParameters Source #
Create a value of PipeSourceDynamoDBStreamParameters 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:batchSize:PipeSourceDynamoDBStreamParameters', pipeSourceDynamoDBStreamParameters_batchSize - The maximum number of records to include in each batch.
$sel:deadLetterConfig:PipeSourceDynamoDBStreamParameters', pipeSourceDynamoDBStreamParameters_deadLetterConfig - Define the target queue to send dead-letter queue events to.
$sel:maximumBatchingWindowInSeconds:PipeSourceDynamoDBStreamParameters', pipeSourceDynamoDBStreamParameters_maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.
$sel:maximumRecordAgeInSeconds:PipeSourceDynamoDBStreamParameters', pipeSourceDynamoDBStreamParameters_maximumRecordAgeInSeconds - (Streams only) Discard records older than the specified age. The default
value is -1, which sets the maximum age to infinite. When the value is
set to infinite, EventBridge never discards old records.
$sel:maximumRetryAttempts:PipeSourceDynamoDBStreamParameters', pipeSourceDynamoDBStreamParameters_maximumRetryAttempts - (Streams only) Discard records after the specified number of retries.
The default value is -1, which sets the maximum number of retries to
infinite. When MaximumRetryAttempts is infinite, EventBridge retries
failed records until the record expires in the event source.
$sel:onPartialBatchItemFailure:PipeSourceDynamoDBStreamParameters', pipeSourceDynamoDBStreamParameters_onPartialBatchItemFailure - (Streams only) Define how to handle item process failures.
AUTOMATIC_BISECT halves each batch and retry each half until all the
records are processed or there is one failed message left in the batch.
$sel:parallelizationFactor:PipeSourceDynamoDBStreamParameters', pipeSourceDynamoDBStreamParameters_parallelizationFactor - (Streams only) The number of batches to process concurrently from each
shard. The default value is 1.
$sel:startingPosition:PipeSourceDynamoDBStreamParameters', pipeSourceDynamoDBStreamParameters_startingPosition - (Streams only) The position in a stream from which to start reading.
PipeSourceKinesisStreamParameters
data PipeSourceKinesisStreamParameters Source #
The parameters for using a Kinesis stream as a source.
See: newPipeSourceKinesisStreamParameters smart constructor.
Constructors
Instances
newPipeSourceKinesisStreamParameters Source #
Arguments
| :: KinesisStreamStartPosition | |
| -> PipeSourceKinesisStreamParameters |
Create a value of PipeSourceKinesisStreamParameters 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:batchSize:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_batchSize - The maximum number of records to include in each batch.
$sel:deadLetterConfig:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_deadLetterConfig - Define the target queue to send dead-letter queue events to.
$sel:maximumBatchingWindowInSeconds:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.
$sel:maximumRecordAgeInSeconds:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_maximumRecordAgeInSeconds - (Streams only) Discard records older than the specified age. The default
value is -1, which sets the maximum age to infinite. When the value is
set to infinite, EventBridge never discards old records.
$sel:maximumRetryAttempts:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_maximumRetryAttempts - (Streams only) Discard records after the specified number of retries.
The default value is -1, which sets the maximum number of retries to
infinite. When MaximumRetryAttempts is infinite, EventBridge retries
failed records until the record expires in the event source.
$sel:onPartialBatchItemFailure:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_onPartialBatchItemFailure - (Streams only) Define how to handle item process failures.
AUTOMATIC_BISECT halves each batch and retry each half until all the
records are processed or there is one failed message left in the batch.
$sel:parallelizationFactor:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_parallelizationFactor - (Streams only) The number of batches to process concurrently from each
shard. The default value is 1.
$sel:startingPositionTimestamp:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_startingPositionTimestamp - With StartingPosition set to AT_TIMESTAMP, the time from which to
start reading, in Unix time seconds.
$sel:startingPosition:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_startingPosition - (Streams only) The position in a stream from which to start reading.
PipeSourceManagedStreamingKafkaParameters
data PipeSourceManagedStreamingKafkaParameters Source #
The parameters for using an MSK stream as a source.
See: newPipeSourceManagedStreamingKafkaParameters smart constructor.
Constructors
| PipeSourceManagedStreamingKafkaParameters' (Maybe Natural) (Maybe (Sensitive Text)) (Maybe MSKAccessCredentials) (Maybe Natural) (Maybe MSKStartPosition) (Sensitive Text) |
Instances
newPipeSourceManagedStreamingKafkaParameters Source #
Arguments
| :: Text | |
| -> PipeSourceManagedStreamingKafkaParameters |
Create a value of PipeSourceManagedStreamingKafkaParameters 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:batchSize:PipeSourceManagedStreamingKafkaParameters', pipeSourceManagedStreamingKafkaParameters_batchSize - The maximum number of records to include in each batch.
$sel:consumerGroupID:PipeSourceManagedStreamingKafkaParameters', pipeSourceManagedStreamingKafkaParameters_consumerGroupID - The name of the destination queue to consume.
$sel:credentials:PipeSourceManagedStreamingKafkaParameters', pipeSourceManagedStreamingKafkaParameters_credentials - The credentials needed to access the resource.
$sel:maximumBatchingWindowInSeconds:PipeSourceManagedStreamingKafkaParameters', pipeSourceManagedStreamingKafkaParameters_maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.
$sel:startingPosition:PipeSourceManagedStreamingKafkaParameters', pipeSourceManagedStreamingKafkaParameters_startingPosition - (Streams only) The position in a stream from which to start reading.
$sel:topicName:PipeSourceManagedStreamingKafkaParameters', pipeSourceManagedStreamingKafkaParameters_topicName - The name of the topic that the pipe will read from.
PipeSourceParameters
data PipeSourceParameters Source #
The parameters required to set up a source for your pipe.
See: newPipeSourceParameters smart constructor.
Constructors
Instances
newPipeSourceParameters :: PipeSourceParameters Source #
Create a value of PipeSourceParameters 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:activeMQBrokerParameters:PipeSourceParameters', pipeSourceParameters_activeMQBrokerParameters - The parameters for using an Active MQ broker as a source.
$sel:dynamoDBStreamParameters:PipeSourceParameters', pipeSourceParameters_dynamoDBStreamParameters - The parameters for using a DynamoDB stream as a source.
$sel:filterCriteria:PipeSourceParameters', pipeSourceParameters_filterCriteria - The collection of event patterns used to filter events. For more
information, see
Events and Event Patterns
in the Amazon EventBridge User Guide.
$sel:kinesisStreamParameters:PipeSourceParameters', pipeSourceParameters_kinesisStreamParameters - The parameters for using a Kinesis stream as a source.
$sel:managedStreamingKafkaParameters:PipeSourceParameters', pipeSourceParameters_managedStreamingKafkaParameters - The parameters for using an MSK stream as a source.
$sel:rabbitMQBrokerParameters:PipeSourceParameters', pipeSourceParameters_rabbitMQBrokerParameters - The parameters for using a Rabbit MQ broker as a source.
$sel:selfManagedKafkaParameters:PipeSourceParameters', pipeSourceParameters_selfManagedKafkaParameters - The parameters for using a self-managed Apache Kafka stream as a source.
$sel:sqsQueueParameters:PipeSourceParameters', pipeSourceParameters_sqsQueueParameters - The parameters for using a Amazon SQS stream as a source.
PipeSourceRabbitMQBrokerParameters
data PipeSourceRabbitMQBrokerParameters Source #
The parameters for using a Rabbit MQ broker as a source.
See: newPipeSourceRabbitMQBrokerParameters smart constructor.
Constructors
| PipeSourceRabbitMQBrokerParameters' (Maybe Natural) (Maybe Natural) (Maybe (Sensitive Text)) MQBrokerAccessCredentials (Sensitive Text) |
Instances
newPipeSourceRabbitMQBrokerParameters Source #
Arguments
| :: MQBrokerAccessCredentials | |
| -> Text | |
| -> PipeSourceRabbitMQBrokerParameters |
Create a value of PipeSourceRabbitMQBrokerParameters 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:batchSize:PipeSourceRabbitMQBrokerParameters', pipeSourceRabbitMQBrokerParameters_batchSize - The maximum number of records to include in each batch.
$sel:maximumBatchingWindowInSeconds:PipeSourceRabbitMQBrokerParameters', pipeSourceRabbitMQBrokerParameters_maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.
$sel:virtualHost:PipeSourceRabbitMQBrokerParameters', pipeSourceRabbitMQBrokerParameters_virtualHost - The name of the virtual host associated with the source broker.
$sel:credentials:PipeSourceRabbitMQBrokerParameters', pipeSourceRabbitMQBrokerParameters_credentials - The credentials needed to access the resource.
$sel:queueName:PipeSourceRabbitMQBrokerParameters', pipeSourceRabbitMQBrokerParameters_queueName - The name of the destination queue to consume.
PipeSourceSelfManagedKafkaParameters
data PipeSourceSelfManagedKafkaParameters Source #
The parameters for using a self-managed Apache Kafka stream as a source.
See: newPipeSourceSelfManagedKafkaParameters smart constructor.
Constructors
Instances
newPipeSourceSelfManagedKafkaParameters Source #
Arguments
| :: Text | |
| -> PipeSourceSelfManagedKafkaParameters |
Create a value of PipeSourceSelfManagedKafkaParameters 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:additionalBootstrapServers:PipeSourceSelfManagedKafkaParameters', pipeSourceSelfManagedKafkaParameters_additionalBootstrapServers - An array of server URLs.
$sel:batchSize:PipeSourceSelfManagedKafkaParameters', pipeSourceSelfManagedKafkaParameters_batchSize - The maximum number of records to include in each batch.
$sel:consumerGroupID:PipeSourceSelfManagedKafkaParameters', pipeSourceSelfManagedKafkaParameters_consumerGroupID - The name of the destination queue to consume.
$sel:credentials:PipeSourceSelfManagedKafkaParameters', pipeSourceSelfManagedKafkaParameters_credentials - The credentials needed to access the resource.
$sel:maximumBatchingWindowInSeconds:PipeSourceSelfManagedKafkaParameters', pipeSourceSelfManagedKafkaParameters_maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.
$sel:serverRootCaCertificate:PipeSourceSelfManagedKafkaParameters', pipeSourceSelfManagedKafkaParameters_serverRootCaCertificate - The ARN of the Secrets Manager secret used for certification.
$sel:startingPosition:PipeSourceSelfManagedKafkaParameters', pipeSourceSelfManagedKafkaParameters_startingPosition - (Streams only) The position in a stream from which to start reading.
$sel:vpc:PipeSourceSelfManagedKafkaParameters', pipeSourceSelfManagedKafkaParameters_vpc - This structure specifies the VPC subnets and security groups for the
stream, and whether a public IP address is to be used.
$sel:topicName:PipeSourceSelfManagedKafkaParameters', pipeSourceSelfManagedKafkaParameters_topicName - The name of the topic that the pipe will read from.
PipeSourceSqsQueueParameters
data PipeSourceSqsQueueParameters Source #
The parameters for using a Amazon SQS stream as a source.
See: newPipeSourceSqsQueueParameters smart constructor.
Constructors
| PipeSourceSqsQueueParameters' (Maybe Natural) (Maybe Natural) |
Instances
newPipeSourceSqsQueueParameters :: PipeSourceSqsQueueParameters Source #
Create a value of PipeSourceSqsQueueParameters 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:batchSize:PipeSourceSqsQueueParameters', pipeSourceSqsQueueParameters_batchSize - The maximum number of records to include in each batch.
$sel:maximumBatchingWindowInSeconds:PipeSourceSqsQueueParameters', pipeSourceSqsQueueParameters_maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.
PipeTargetBatchJobParameters
data PipeTargetBatchJobParameters Source #
The parameters for using an Batch job as a target.
See: newPipeTargetBatchJobParameters smart constructor.
Constructors
| PipeTargetBatchJobParameters' (Maybe BatchArrayProperties) (Maybe BatchContainerOverrides) (Maybe [BatchJobDependency]) (Maybe (HashMap Text Text)) (Maybe BatchRetryStrategy) Text Text |
Instances
newPipeTargetBatchJobParameters Source #
Arguments
| :: Text | |
| -> Text | |
| -> PipeTargetBatchJobParameters |
Create a value of PipeTargetBatchJobParameters 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:arrayProperties:PipeTargetBatchJobParameters', pipeTargetBatchJobParameters_arrayProperties - The array properties for the submitted job, such as the size of the
array. The array size can be between 2 and 10,000. If you specify array
properties for a job, it becomes an array job. This parameter is used
only if the target is an Batch job.
$sel:containerOverrides:PipeTargetBatchJobParameters', pipeTargetBatchJobParameters_containerOverrides - The overrides that are sent to a container.
$sel:dependsOn:PipeTargetBatchJobParameters', pipeTargetBatchJobParameters_dependsOn - A list of dependencies for the job. A job can depend upon a maximum of
20 jobs. You can specify a SEQUENTIAL type dependency without
specifying a job ID for array jobs so that each child array job
completes sequentially, starting at index 0. You can also specify an
N_TO_N type dependency with a job ID for array jobs. In that case,
each index child of this job must wait for the corresponding index child
of each dependency to complete before it can begin.
$sel:parameters:PipeTargetBatchJobParameters', pipeTargetBatchJobParameters_parameters - Additional parameters passed to the job that replace parameter
substitution placeholders that are set in the job definition. Parameters
are specified as a key and value pair mapping. Parameters included here
override any corresponding parameter defaults from the job definition.
$sel:retryStrategy:PipeTargetBatchJobParameters', pipeTargetBatchJobParameters_retryStrategy - The retry strategy to use for failed jobs. When a retry strategy is
specified here, it overrides the retry strategy defined in the job
definition.
$sel:jobDefinition:PipeTargetBatchJobParameters', pipeTargetBatchJobParameters_jobDefinition - The job definition used by this job. This value can be one of name,
name:revision, or the Amazon Resource Name (ARN) for the job
definition. If name is specified without a revision then the latest
active revision is used.
$sel:jobName:PipeTargetBatchJobParameters', pipeTargetBatchJobParameters_jobName - The name of the job. It can be up to 128 letters long. The first
character must be alphanumeric, can contain uppercase and lowercase
letters, numbers, hyphens (-), and underscores (_).
PipeTargetCloudWatchLogsParameters
data PipeTargetCloudWatchLogsParameters Source #
The parameters for using an CloudWatch Logs log stream as a target.
See: newPipeTargetCloudWatchLogsParameters smart constructor.
Constructors
| PipeTargetCloudWatchLogsParameters' (Maybe Text) (Maybe Text) |
Instances
newPipeTargetCloudWatchLogsParameters :: PipeTargetCloudWatchLogsParameters Source #
Create a value of PipeTargetCloudWatchLogsParameters 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:logStreamName:PipeTargetCloudWatchLogsParameters', pipeTargetCloudWatchLogsParameters_logStreamName - The name of the log stream.
$sel:timestamp:PipeTargetCloudWatchLogsParameters', pipeTargetCloudWatchLogsParameters_timestamp - The time the event occurred, expressed as the number of milliseconds
after Jan 1, 1970 00:00:00 UTC.
PipeTargetEcsTaskParameters
data PipeTargetEcsTaskParameters Source #
The parameters for using an Amazon ECS task as a target.
See: newPipeTargetEcsTaskParameters smart constructor.
Constructors
| PipeTargetEcsTaskParameters' (Maybe [CapacityProviderStrategyItem]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe LaunchType) (Maybe NetworkConfiguration) (Maybe EcsTaskOverride) (Maybe [PlacementConstraint]) (Maybe [PlacementStrategy]) (Maybe Text) (Maybe PropagateTags) (Maybe (Sensitive Text)) (Maybe [Tag]) (Maybe Natural) Text |
Instances
newPipeTargetEcsTaskParameters Source #
Create a value of PipeTargetEcsTaskParameters 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:capacityProviderStrategy:PipeTargetEcsTaskParameters', pipeTargetEcsTaskParameters_capacityProviderStrategy - The capacity provider strategy to use for the task.
If a capacityProviderStrategy is specified, the launchType parameter
must be omitted. If no capacityProviderStrategy or launchType is
specified, the defaultCapacityProviderStrategy for the cluster is
used.
$sel:enableECSManagedTags:PipeTargetEcsTaskParameters', pipeTargetEcsTaskParameters_enableECSManagedTags - Specifies whether to enable Amazon ECS managed tags for the task. For
more information, see
Tagging Your Amazon ECS Resources
in the Amazon Elastic Container Service Developer Guide.
$sel:enableExecuteCommand:PipeTargetEcsTaskParameters', pipeTargetEcsTaskParameters_enableExecuteCommand - Whether or not to enable the execute command functionality for the
containers in this task. If true, this enables execute command
functionality on all containers in the task.
$sel:group':PipeTargetEcsTaskParameters', pipeTargetEcsTaskParameters_group - Specifies an Amazon ECS task group for the task. The maximum length is
255 characters.
$sel:launchType:PipeTargetEcsTaskParameters', pipeTargetEcsTaskParameters_launchType - Specifies the launch type on which your task is running. The launch type
that you specify here must match one of the launch type
(compatibilities) of the target task. The FARGATE value is supported
only in the Regions where Fargate with Amazon ECS is supported. For more
information, see
Fargate on Amazon ECS
in the Amazon Elastic Container Service Developer Guide.
$sel:networkConfiguration:PipeTargetEcsTaskParameters', pipeTargetEcsTaskParameters_networkConfiguration - Use this structure if the Amazon ECS task uses the awsvpc network
mode. This structure specifies the VPC subnets and security groups
associated with the task, and whether a public IP address is to be used.
This structure is required if LaunchType is FARGATE because the
awsvpc mode is required for Fargate tasks.
If you specify NetworkConfiguration when the target ECS task does not
use the awsvpc network mode, the task fails.
$sel:overrides:PipeTargetEcsTaskParameters', pipeTargetEcsTaskParameters_overrides - The overrides that are associated with a task.
$sel:placementConstraints:PipeTargetEcsTaskParameters', pipeTargetEcsTaskParameters_placementConstraints - An array of placement constraint objects to use for the task. You can
specify up to 10 constraints per task (including constraints in the task
definition and those specified at runtime).
$sel:placementStrategy:PipeTargetEcsTaskParameters', pipeTargetEcsTaskParameters_placementStrategy - The placement strategy objects to use for the task. You can specify a
maximum of five strategy rules per task.
$sel:platformVersion:PipeTargetEcsTaskParameters', pipeTargetEcsTaskParameters_platformVersion - Specifies the platform version for the task. Specify only the numeric
portion of the platform version, such as 1.1.0.
This structure is used only if LaunchType is FARGATE. For more
information about valid platform versions, see
Fargate Platform Versions
in the Amazon Elastic Container Service Developer Guide.
$sel:propagateTags:PipeTargetEcsTaskParameters', pipeTargetEcsTaskParameters_propagateTags - Specifies whether to propagate the tags from the task definition to the
task. If no value is specified, the tags are not propagated. Tags can
only be propagated to the task during task creation. To add tags to a
task after task creation, use the TagResource API action.
$sel:referenceId:PipeTargetEcsTaskParameters', pipeTargetEcsTaskParameters_referenceId - The reference ID to use for the task.
$sel:tags:PipeTargetEcsTaskParameters', pipeTargetEcsTaskParameters_tags - The metadata that you apply to the task to help you categorize and
organize them. Each tag consists of a key and an optional value, both of
which you define. To learn more, see
RunTask
in the Amazon ECS API Reference.
$sel:taskCount:PipeTargetEcsTaskParameters', pipeTargetEcsTaskParameters_taskCount - The number of tasks to create based on TaskDefinition. The default is
1.
$sel:taskDefinitionArn:PipeTargetEcsTaskParameters', pipeTargetEcsTaskParameters_taskDefinitionArn - The ARN of the task definition to use if the event target is an Amazon
ECS task.
PipeTargetEventBridgeEventBusParameters
data PipeTargetEventBridgeEventBusParameters Source #
The parameters for using an EventBridge event bus as a target.
See: newPipeTargetEventBridgeEventBusParameters smart constructor.
Constructors
| PipeTargetEventBridgeEventBusParameters' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe [Text]) (Maybe (Sensitive Text)) (Maybe Text) |
Instances
newPipeTargetEventBridgeEventBusParameters :: PipeTargetEventBridgeEventBusParameters Source #
Create a value of PipeTargetEventBridgeEventBusParameters 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:detailType:PipeTargetEventBridgeEventBusParameters', pipeTargetEventBridgeEventBusParameters_detailType - A free-form string, with a maximum of 128 characters, used to decide
what fields to expect in the event detail.
$sel:endpointId:PipeTargetEventBridgeEventBusParameters', pipeTargetEventBridgeEventBusParameters_endpointId - The URL subdomain of the endpoint. For example, if the URL for Endpoint
is https://abcde.veo.endpoints.event.amazonaws.com, then the
EndpointId is abcde.veo.
When using Java, you must include auth-crt on the class path.
$sel:resources:PipeTargetEventBridgeEventBusParameters', pipeTargetEventBridgeEventBusParameters_resources - Amazon Web Services resources, identified by Amazon Resource Name (ARN),
which the event primarily concerns. Any number, including zero, may be
present.
$sel:source:PipeTargetEventBridgeEventBusParameters', pipeTargetEventBridgeEventBusParameters_source - The source of the event.
$sel:time:PipeTargetEventBridgeEventBusParameters', pipeTargetEventBridgeEventBusParameters_time - The time stamp of the event, per
RFC3339. If no time stamp
is provided, the time stamp of the
PutEvents
call is used.
PipeTargetHttpParameters
data PipeTargetHttpParameters Source #
These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
See: newPipeTargetHttpParameters smart constructor.
Constructors
| PipeTargetHttpParameters' (Maybe (HashMap Text (Sensitive Text))) (Maybe [Sensitive Text]) (Maybe (HashMap Text (Sensitive Text))) |
Instances
newPipeTargetHttpParameters :: PipeTargetHttpParameters Source #
Create a value of PipeTargetHttpParameters 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:headerParameters:PipeTargetHttpParameters', pipeTargetHttpParameters_headerParameters - The headers that need to be sent as part of request invoking the API
Gateway REST API or EventBridge ApiDestination.
$sel:pathParameterValues:PipeTargetHttpParameters', pipeTargetHttpParameters_pathParameterValues - The path parameter values to be used to populate API Gateway REST API or
EventBridge ApiDestination path wildcards ("*").
$sel:queryStringParameters:PipeTargetHttpParameters', pipeTargetHttpParameters_queryStringParameters - The query string keys/values that need to be sent as part of request
invoking the API Gateway REST API or EventBridge ApiDestination.
PipeTargetKinesisStreamParameters
data PipeTargetKinesisStreamParameters Source #
The parameters for using a Kinesis stream as a source.
See: newPipeTargetKinesisStreamParameters smart constructor.
Constructors
| PipeTargetKinesisStreamParameters' (Sensitive Text) |
Instances
newPipeTargetKinesisStreamParameters Source #
Arguments
| :: Text | |
| -> PipeTargetKinesisStreamParameters |
Create a value of PipeTargetKinesisStreamParameters 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:partitionKey:PipeTargetKinesisStreamParameters', pipeTargetKinesisStreamParameters_partitionKey - Determines which shard in the stream the data record is assigned to.
Partition keys are Unicode strings with a maximum length limit of 256
characters for each key. Amazon Kinesis Data Streams uses the partition
key as input to a hash function that maps the partition key and
associated data to a specific shard. Specifically, an MD5 hash function
is used to map partition keys to 128-bit integer values and to map
associated data records to shards. As a result of this hashing
mechanism, all data records with the same partition key map to the same
shard within the stream.
PipeTargetLambdaFunctionParameters
data PipeTargetLambdaFunctionParameters Source #
The parameters for using a Lambda function as a target.
See: newPipeTargetLambdaFunctionParameters smart constructor.
Constructors
| PipeTargetLambdaFunctionParameters' (Maybe PipeTargetInvocationType) |
Instances
newPipeTargetLambdaFunctionParameters :: PipeTargetLambdaFunctionParameters Source #
Create a value of PipeTargetLambdaFunctionParameters 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:invocationType:PipeTargetLambdaFunctionParameters', pipeTargetLambdaFunctionParameters_invocationType - Choose from the following options.
RequestResponse(default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API response includes the function response and additional data.Event- Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if it's configured). The API response only includes a status code.DryRun- Validate parameter values and verify that the user or role has permission to invoke the function.
PipeTargetParameters
data PipeTargetParameters Source #
The parameters required to set up a target for your pipe.
See: newPipeTargetParameters smart constructor.
Constructors
Instances
newPipeTargetParameters :: PipeTargetParameters Source #
Create a value of PipeTargetParameters 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:batchJobParameters:PipeTargetParameters', pipeTargetParameters_batchJobParameters - The parameters for using an Batch job as a target.
$sel:cloudWatchLogsParameters:PipeTargetParameters', pipeTargetParameters_cloudWatchLogsParameters - The parameters for using an CloudWatch Logs log stream as a target.
$sel:ecsTaskParameters:PipeTargetParameters', pipeTargetParameters_ecsTaskParameters - The parameters for using an Amazon ECS task as a target.
$sel:eventBridgeEventBusParameters:PipeTargetParameters', pipeTargetParameters_eventBridgeEventBusParameters - The parameters for using an EventBridge event bus as a target.
$sel:httpParameters:PipeTargetParameters', pipeTargetParameters_httpParameters - These are custom parameter to be used when the target is an API Gateway
REST APIs or EventBridge ApiDestinations.
$sel:inputTemplate:PipeTargetParameters', pipeTargetParameters_inputTemplate - Valid JSON text passed to the target. In this case, nothing from the
event itself is passed to the target. For more information, see
The JavaScript Object Notation (JSON) Data Interchange Format.
$sel:kinesisStreamParameters:PipeTargetParameters', pipeTargetParameters_kinesisStreamParameters - The parameters for using a Kinesis stream as a source.
$sel:lambdaFunctionParameters:PipeTargetParameters', pipeTargetParameters_lambdaFunctionParameters - The parameters for using a Lambda function as a target.
$sel:redshiftDataParameters:PipeTargetParameters', pipeTargetParameters_redshiftDataParameters - These are custom parameters to be used when the target is a Amazon
Redshift cluster to invoke the Amazon Redshift Data API
ExecuteStatement.
$sel:sageMakerPipelineParameters:PipeTargetParameters', pipeTargetParameters_sageMakerPipelineParameters - The parameters for using a SageMaker pipeline as a target.
$sel:sqsQueueParameters:PipeTargetParameters', pipeTargetParameters_sqsQueueParameters - The parameters for using a Amazon SQS stream as a source.
$sel:stepFunctionStateMachineParameters:PipeTargetParameters', pipeTargetParameters_stepFunctionStateMachineParameters - The parameters for using a Step Functions state machine as a target.
PipeTargetRedshiftDataParameters
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' (Maybe (Sensitive Text)) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Bool) (Sensitive Text) (NonEmpty (Sensitive Text)) |
Instances
newPipeTargetRedshiftDataParameters Source #
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> 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.
PipeTargetSageMakerPipelineParameters
data PipeTargetSageMakerPipelineParameters Source #
The parameters for using a SageMaker pipeline as a target.
See: newPipeTargetSageMakerPipelineParameters smart constructor.
Constructors
| PipeTargetSageMakerPipelineParameters' (Maybe [SageMakerPipelineParameter]) |
Instances
newPipeTargetSageMakerPipelineParameters :: PipeTargetSageMakerPipelineParameters Source #
Create a value of PipeTargetSageMakerPipelineParameters 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:pipelineParameterList:PipeTargetSageMakerPipelineParameters', pipeTargetSageMakerPipelineParameters_pipelineParameterList - List of Parameter names and values for SageMaker Model Building Pipeline
execution.
PipeTargetSqsQueueParameters
data PipeTargetSqsQueueParameters Source #
The parameters for using a Amazon SQS stream as a source.
See: newPipeTargetSqsQueueParameters smart constructor.
Instances
newPipeTargetSqsQueueParameters :: PipeTargetSqsQueueParameters Source #
Create a value of PipeTargetSqsQueueParameters 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:messageDeduplicationId:PipeTargetSqsQueueParameters', pipeTargetSqsQueueParameters_messageDeduplicationId - This parameter applies only to FIFO (first-in-first-out) queues.
The token used for deduplication of sent messages.
$sel:messageGroupId:PipeTargetSqsQueueParameters', pipeTargetSqsQueueParameters_messageGroupId - The FIFO message group ID to use as the target.
PipeTargetStateMachineParameters
data PipeTargetStateMachineParameters Source #
The parameters for using a Step Functions state machine as a target.
See: newPipeTargetStateMachineParameters smart constructor.
Constructors
| PipeTargetStateMachineParameters' (Maybe PipeTargetInvocationType) |
Instances
newPipeTargetStateMachineParameters :: PipeTargetStateMachineParameters Source #
Create a value of PipeTargetStateMachineParameters 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:invocationType:PipeTargetStateMachineParameters', pipeTargetStateMachineParameters_invocationType - Specify whether to wait for the state machine to finish or not.
PlacementConstraint
data PlacementConstraint Source #
An object representing a constraint on task placement. To learn more, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
See: newPlacementConstraint smart constructor.
Constructors
| PlacementConstraint' (Maybe (Sensitive Text)) (Maybe PlacementConstraintType) |
Instances
newPlacementConstraint :: PlacementConstraint Source #
Create a value of PlacementConstraint 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:expression:PlacementConstraint', placementConstraint_expression - A cluster query language expression to apply to the constraint. You
cannot specify an expression if the constraint type is
distinctInstance. To learn more, see
Cluster Query Language
in the Amazon Elastic Container Service Developer Guide.
$sel:type':PlacementConstraint', placementConstraint_type - The type of constraint. Use distinctInstance to ensure that each task in
a particular group is running on a different container instance. Use
memberOf to restrict the selection to a group of valid candidates.
PlacementStrategy
data PlacementStrategy Source #
The task placement strategy for a task or service. To learn more, see Task Placement Strategies in the Amazon Elastic Container Service Service Developer Guide.
See: newPlacementStrategy smart constructor.
Constructors
| PlacementStrategy' (Maybe (Sensitive Text)) (Maybe PlacementStrategyType) |
Instances
newPlacementStrategy :: PlacementStrategy Source #
Create a value of PlacementStrategy 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:field:PlacementStrategy', placementStrategy_field - The field to apply the placement strategy against. For the spread
placement strategy, valid values are instanceId (or host, which has the
same effect), or any platform or custom attribute that is applied to a
container instance, such as attribute:ecs.availability-zone. For the
binpack placement strategy, valid values are cpu and memory. For the
random placement strategy, this field is not used.
$sel:type':PlacementStrategy', placementStrategy_type - The type of placement strategy. The random placement strategy randomly
places tasks on available candidates. The spread placement strategy
spreads placement across available candidates evenly based on the field
parameter. The binpack strategy places tasks on available candidates
that have the least available amount of the resource that is specified
with the field parameter. For example, if you binpack on memory, a task
is placed on the instance with the least amount of remaining memory (but
still enough to run the task).
SageMakerPipelineParameter
data SageMakerPipelineParameter Source #
Name/Value pair of a parameter to start execution of a SageMaker Model Building Pipeline.
See: newSageMakerPipelineParameter smart constructor.
Constructors
| SageMakerPipelineParameter' (Sensitive Text) (Sensitive Text) |
Instances
newSageMakerPipelineParameter Source #
Arguments
| :: Text | |
| -> Text | |
| -> SageMakerPipelineParameter |
Create a value of SageMakerPipelineParameter 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:name:SageMakerPipelineParameter', sageMakerPipelineParameter_name - Name of parameter to start execution of a SageMaker Model Building
Pipeline.
$sel:value:SageMakerPipelineParameter', sageMakerPipelineParameter_value - Value of parameter to start execution of a SageMaker Model Building
Pipeline.
SelfManagedKafkaAccessConfigurationCredentials
data SelfManagedKafkaAccessConfigurationCredentials Source #
The Secrets Manager secret that stores your stream credentials.
See: newSelfManagedKafkaAccessConfigurationCredentials smart constructor.
Constructors
| SelfManagedKafkaAccessConfigurationCredentials' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newSelfManagedKafkaAccessConfigurationCredentials :: SelfManagedKafkaAccessConfigurationCredentials Source #
Create a value of SelfManagedKafkaAccessConfigurationCredentials 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:basicAuth:SelfManagedKafkaAccessConfigurationCredentials', selfManagedKafkaAccessConfigurationCredentials_basicAuth - The ARN of the Secrets Manager secret.
$sel:clientCertificateTlsAuth:SelfManagedKafkaAccessConfigurationCredentials', selfManagedKafkaAccessConfigurationCredentials_clientCertificateTlsAuth - The ARN of the Secrets Manager secret.
$sel:saslScram256Auth:SelfManagedKafkaAccessConfigurationCredentials', selfManagedKafkaAccessConfigurationCredentials_saslScram256Auth - The ARN of the Secrets Manager secret.
$sel:saslScram512Auth:SelfManagedKafkaAccessConfigurationCredentials', selfManagedKafkaAccessConfigurationCredentials_saslScram512Auth - The ARN of the Secrets Manager secret.
SelfManagedKafkaAccessConfigurationVpc
data SelfManagedKafkaAccessConfigurationVpc Source #
This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
See: newSelfManagedKafkaAccessConfigurationVpc smart constructor.
Constructors
| SelfManagedKafkaAccessConfigurationVpc' (Maybe [Sensitive Text]) (Maybe [Sensitive Text]) |
Instances
newSelfManagedKafkaAccessConfigurationVpc :: SelfManagedKafkaAccessConfigurationVpc Source #
Create a value of SelfManagedKafkaAccessConfigurationVpc 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:securityGroup:SelfManagedKafkaAccessConfigurationVpc', selfManagedKafkaAccessConfigurationVpc_securityGroup - Specifies the security groups associated with the stream. These security
groups must all be in the same VPC. You can specify as many as five
security groups. If you do not specify a security group, the default
security group for the VPC is used.
$sel:subnets:SelfManagedKafkaAccessConfigurationVpc', selfManagedKafkaAccessConfigurationVpc_subnets - Specifies the subnets associated with the stream. These subnets must all
be in the same VPC. You can specify as many as 16 subnets.
Tag
A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging.
See: newTag smart constructor.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.Pipes.Types.Tag | |
| Generic Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.Pipes.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.Pipes.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.Pipes.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Pipes.Types.Tag" "amazonka-pipes-2.0-DDuNjbjVfgsJFLlibzr06i" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))) | |
Create a value of Tag 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:key:Tag', tag_key - A string you can use to assign a value. The combination of tag keys and
values can help you organize and categorize your resources.
$sel:value:Tag', tag_value - The value for the specified tag key.
UpdatePipeSourceActiveMQBrokerParameters
data UpdatePipeSourceActiveMQBrokerParameters Source #
The parameters for using an Active MQ broker as a source.
See: newUpdatePipeSourceActiveMQBrokerParameters smart constructor.
Constructors
| UpdatePipeSourceActiveMQBrokerParameters' (Maybe Natural) (Maybe Natural) MQBrokerAccessCredentials |
Instances
newUpdatePipeSourceActiveMQBrokerParameters Source #
Create a value of UpdatePipeSourceActiveMQBrokerParameters 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:batchSize:UpdatePipeSourceActiveMQBrokerParameters', updatePipeSourceActiveMQBrokerParameters_batchSize - The maximum number of records to include in each batch.
$sel:maximumBatchingWindowInSeconds:UpdatePipeSourceActiveMQBrokerParameters', updatePipeSourceActiveMQBrokerParameters_maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.
$sel:credentials:UpdatePipeSourceActiveMQBrokerParameters', updatePipeSourceActiveMQBrokerParameters_credentials - The credentials needed to access the resource.
UpdatePipeSourceDynamoDBStreamParameters
data UpdatePipeSourceDynamoDBStreamParameters Source #
The parameters for using a DynamoDB stream as a source.
See: newUpdatePipeSourceDynamoDBStreamParameters smart constructor.
Constructors
| UpdatePipeSourceDynamoDBStreamParameters' (Maybe Natural) (Maybe DeadLetterConfig) (Maybe Natural) (Maybe Int) (Maybe Int) (Maybe OnPartialBatchItemFailureStreams) (Maybe Natural) |
Instances
newUpdatePipeSourceDynamoDBStreamParameters :: UpdatePipeSourceDynamoDBStreamParameters Source #
Create a value of UpdatePipeSourceDynamoDBStreamParameters 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:batchSize:UpdatePipeSourceDynamoDBStreamParameters', updatePipeSourceDynamoDBStreamParameters_batchSize - The maximum number of records to include in each batch.
$sel:deadLetterConfig:UpdatePipeSourceDynamoDBStreamParameters', updatePipeSourceDynamoDBStreamParameters_deadLetterConfig - Define the target queue to send dead-letter queue events to.
$sel:maximumBatchingWindowInSeconds:UpdatePipeSourceDynamoDBStreamParameters', updatePipeSourceDynamoDBStreamParameters_maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.
$sel:maximumRecordAgeInSeconds:UpdatePipeSourceDynamoDBStreamParameters', updatePipeSourceDynamoDBStreamParameters_maximumRecordAgeInSeconds - (Streams only) Discard records older than the specified age. The default
value is -1, which sets the maximum age to infinite. When the value is
set to infinite, EventBridge never discards old records.
$sel:maximumRetryAttempts:UpdatePipeSourceDynamoDBStreamParameters', updatePipeSourceDynamoDBStreamParameters_maximumRetryAttempts - (Streams only) Discard records after the specified number of retries.
The default value is -1, which sets the maximum number of retries to
infinite. When MaximumRetryAttempts is infinite, EventBridge retries
failed records until the record expires in the event source.
$sel:onPartialBatchItemFailure:UpdatePipeSourceDynamoDBStreamParameters', updatePipeSourceDynamoDBStreamParameters_onPartialBatchItemFailure - (Streams only) Define how to handle item process failures.
AUTOMATIC_BISECT halves each batch and retry each half until all the
records are processed or there is one failed message left in the batch.
$sel:parallelizationFactor:UpdatePipeSourceDynamoDBStreamParameters', updatePipeSourceDynamoDBStreamParameters_parallelizationFactor - (Streams only) The number of batches to process concurrently from each
shard. The default value is 1.
UpdatePipeSourceKinesisStreamParameters
data UpdatePipeSourceKinesisStreamParameters Source #
The parameters for using a Kinesis stream as a source.
See: newUpdatePipeSourceKinesisStreamParameters smart constructor.
Constructors
| UpdatePipeSourceKinesisStreamParameters' (Maybe Natural) (Maybe DeadLetterConfig) (Maybe Natural) (Maybe Int) (Maybe Int) (Maybe OnPartialBatchItemFailureStreams) (Maybe Natural) |
Instances
newUpdatePipeSourceKinesisStreamParameters :: UpdatePipeSourceKinesisStreamParameters Source #
Create a value of UpdatePipeSourceKinesisStreamParameters 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:batchSize:UpdatePipeSourceKinesisStreamParameters', updatePipeSourceKinesisStreamParameters_batchSize - The maximum number of records to include in each batch.
$sel:deadLetterConfig:UpdatePipeSourceKinesisStreamParameters', updatePipeSourceKinesisStreamParameters_deadLetterConfig - Define the target queue to send dead-letter queue events to.
$sel:maximumBatchingWindowInSeconds:UpdatePipeSourceKinesisStreamParameters', updatePipeSourceKinesisStreamParameters_maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.
$sel:maximumRecordAgeInSeconds:UpdatePipeSourceKinesisStreamParameters', updatePipeSourceKinesisStreamParameters_maximumRecordAgeInSeconds - (Streams only) Discard records older than the specified age. The default
value is -1, which sets the maximum age to infinite. When the value is
set to infinite, EventBridge never discards old records.
$sel:maximumRetryAttempts:UpdatePipeSourceKinesisStreamParameters', updatePipeSourceKinesisStreamParameters_maximumRetryAttempts - (Streams only) Discard records after the specified number of retries.
The default value is -1, which sets the maximum number of retries to
infinite. When MaximumRetryAttempts is infinite, EventBridge retries
failed records until the record expires in the event source.
$sel:onPartialBatchItemFailure:UpdatePipeSourceKinesisStreamParameters', updatePipeSourceKinesisStreamParameters_onPartialBatchItemFailure - (Streams only) Define how to handle item process failures.
AUTOMATIC_BISECT halves each batch and retry each half until all the
records are processed or there is one failed message left in the batch.
$sel:parallelizationFactor:UpdatePipeSourceKinesisStreamParameters', updatePipeSourceKinesisStreamParameters_parallelizationFactor - (Streams only) The number of batches to process concurrently from each
shard. The default value is 1.
UpdatePipeSourceManagedStreamingKafkaParameters
data UpdatePipeSourceManagedStreamingKafkaParameters Source #
The parameters for using an MSK stream as a source.
See: newUpdatePipeSourceManagedStreamingKafkaParameters smart constructor.
Constructors
| UpdatePipeSourceManagedStreamingKafkaParameters' (Maybe Natural) (Maybe MSKAccessCredentials) (Maybe Natural) |
Instances
newUpdatePipeSourceManagedStreamingKafkaParameters :: UpdatePipeSourceManagedStreamingKafkaParameters Source #
Create a value of UpdatePipeSourceManagedStreamingKafkaParameters 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:batchSize:UpdatePipeSourceManagedStreamingKafkaParameters', updatePipeSourceManagedStreamingKafkaParameters_batchSize - The maximum number of records to include in each batch.
$sel:credentials:UpdatePipeSourceManagedStreamingKafkaParameters', updatePipeSourceManagedStreamingKafkaParameters_credentials - The credentials needed to access the resource.
$sel:maximumBatchingWindowInSeconds:UpdatePipeSourceManagedStreamingKafkaParameters', updatePipeSourceManagedStreamingKafkaParameters_maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.
UpdatePipeSourceParameters
data UpdatePipeSourceParameters Source #
The parameters required to set up a source for your pipe.
See: newUpdatePipeSourceParameters smart constructor.
Constructors
Instances
newUpdatePipeSourceParameters :: UpdatePipeSourceParameters Source #
Create a value of UpdatePipeSourceParameters 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:activeMQBrokerParameters:UpdatePipeSourceParameters', updatePipeSourceParameters_activeMQBrokerParameters - The parameters for using an Active MQ broker as a source.
$sel:dynamoDBStreamParameters:UpdatePipeSourceParameters', updatePipeSourceParameters_dynamoDBStreamParameters - The parameters for using a DynamoDB stream as a source.
$sel:filterCriteria:UpdatePipeSourceParameters', updatePipeSourceParameters_filterCriteria - The collection of event patterns used to filter events. For more
information, see
Events and Event Patterns
in the Amazon EventBridge User Guide.
$sel:kinesisStreamParameters:UpdatePipeSourceParameters', updatePipeSourceParameters_kinesisStreamParameters - The parameters for using a Kinesis stream as a source.
$sel:managedStreamingKafkaParameters:UpdatePipeSourceParameters', updatePipeSourceParameters_managedStreamingKafkaParameters - The parameters for using an MSK stream as a source.
$sel:rabbitMQBrokerParameters:UpdatePipeSourceParameters', updatePipeSourceParameters_rabbitMQBrokerParameters - The parameters for using a Rabbit MQ broker as a source.
$sel:selfManagedKafkaParameters:UpdatePipeSourceParameters', updatePipeSourceParameters_selfManagedKafkaParameters - The parameters for using a self-managed Apache Kafka stream as a source.
$sel:sqsQueueParameters:UpdatePipeSourceParameters', updatePipeSourceParameters_sqsQueueParameters - The parameters for using a Amazon SQS stream as a source.
UpdatePipeSourceRabbitMQBrokerParameters
data UpdatePipeSourceRabbitMQBrokerParameters Source #
The parameters for using a Rabbit MQ broker as a source.
See: newUpdatePipeSourceRabbitMQBrokerParameters smart constructor.
Constructors
| UpdatePipeSourceRabbitMQBrokerParameters' (Maybe Natural) (Maybe Natural) MQBrokerAccessCredentials |
Instances
newUpdatePipeSourceRabbitMQBrokerParameters Source #
Create a value of UpdatePipeSourceRabbitMQBrokerParameters 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:batchSize:UpdatePipeSourceRabbitMQBrokerParameters', updatePipeSourceRabbitMQBrokerParameters_batchSize - The maximum number of records to include in each batch.
$sel:maximumBatchingWindowInSeconds:UpdatePipeSourceRabbitMQBrokerParameters', updatePipeSourceRabbitMQBrokerParameters_maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.
$sel:credentials:UpdatePipeSourceRabbitMQBrokerParameters', updatePipeSourceRabbitMQBrokerParameters_credentials - The credentials needed to access the resource.
UpdatePipeSourceSelfManagedKafkaParameters
data UpdatePipeSourceSelfManagedKafkaParameters Source #
The parameters for using a self-managed Apache Kafka stream as a source.
See: newUpdatePipeSourceSelfManagedKafkaParameters smart constructor.
Constructors
| UpdatePipeSourceSelfManagedKafkaParameters' (Maybe Natural) (Maybe SelfManagedKafkaAccessConfigurationCredentials) (Maybe Natural) (Maybe Text) (Maybe SelfManagedKafkaAccessConfigurationVpc) |
Instances
newUpdatePipeSourceSelfManagedKafkaParameters :: UpdatePipeSourceSelfManagedKafkaParameters Source #
Create a value of UpdatePipeSourceSelfManagedKafkaParameters 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:batchSize:UpdatePipeSourceSelfManagedKafkaParameters', updatePipeSourceSelfManagedKafkaParameters_batchSize - The maximum number of records to include in each batch.
$sel:credentials:UpdatePipeSourceSelfManagedKafkaParameters', updatePipeSourceSelfManagedKafkaParameters_credentials - The credentials needed to access the resource.
$sel:maximumBatchingWindowInSeconds:UpdatePipeSourceSelfManagedKafkaParameters', updatePipeSourceSelfManagedKafkaParameters_maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.
$sel:serverRootCaCertificate:UpdatePipeSourceSelfManagedKafkaParameters', updatePipeSourceSelfManagedKafkaParameters_serverRootCaCertificate - The ARN of the Secrets Manager secret used for certification.
$sel:vpc:UpdatePipeSourceSelfManagedKafkaParameters', updatePipeSourceSelfManagedKafkaParameters_vpc - This structure specifies the VPC subnets and security groups for the
stream, and whether a public IP address is to be used.
UpdatePipeSourceSqsQueueParameters
data UpdatePipeSourceSqsQueueParameters Source #
The parameters for using a Amazon SQS stream as a source.
See: newUpdatePipeSourceSqsQueueParameters smart constructor.
Constructors
| UpdatePipeSourceSqsQueueParameters' (Maybe Natural) (Maybe Natural) |
Instances
newUpdatePipeSourceSqsQueueParameters :: UpdatePipeSourceSqsQueueParameters Source #
Create a value of UpdatePipeSourceSqsQueueParameters 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:batchSize:UpdatePipeSourceSqsQueueParameters', updatePipeSourceSqsQueueParameters_batchSize - The maximum number of records to include in each batch.
$sel:maximumBatchingWindowInSeconds:UpdatePipeSourceSqsQueueParameters', updatePipeSourceSqsQueueParameters_maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.