AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon EventBridgeV2 CreateSubscriber API operation.

Syntax

New-EVBV2Subscriber
-OnFailureConfiguration_Arn <String>
-InvokeConfiguration_EventBusV2Parameters_SystemMetadata_DeduplicationId <String>
-InvokeConfiguration_EventBusV2Parameters_DeduplicationConfiguration_DeduplicationType <DeduplicationType>
-InvokeConfiguration_SqsParameters_DelaySecond <String>
-Description <String>
-InvokeConfiguration_LambdaParameters_DurableExecutionName <String>
-PointInTimeConfiguration_EndPoint <DateTime>
-EventBusArn <String>
-InvokeConfiguration_EventBusV2Parameters_SystemMetadata_EventGroupId <String>
-InvokeConfiguration_KinesisParameters_ExplicitHashKey <String>
-Transformer_JsonataConfiguration_Expression <String>
-FilterConfiguration_Filter <Filter[]>
-InvokeConfiguration_HttpParameters_HeaderParameter <Hashtable>
-LogConfiguration_IncludePayload <IncludePayload>
-InvokeConfiguration_UniversalTargetParameters_Input <String>
-InvokeConfiguration_HttpParameters_InvocationTimeoutSecond <String>
-InvokeConfiguration_LambdaParameters_InvocationTimeoutSecond <String>
-InvokeConfiguration_StepFunctionsParameters_InvocationTimeoutSecond <String>
-InvokeConfiguration_UniversalTargetParameters_InvocationTimeoutSecond <String>
-InvokeConfiguration_LambdaParameters_InvocationType <InvocationType>
-InvokeConfiguration_StepFunctionsParameters_InvocationType <InvocationType>
-FilterConfiguration_Language <FilterLanguage>
-LogConfiguration_Level <LogLevel>
-BatchConfiguration_MaxBatchSize <Int32>
-BatchConfiguration_MaxBatchWindowInSecond <Int32>
-RetryPolicy_MaxEventAgeInSecond <Int32>
-RetryPolicy_MaxRetryAttempt <Int32>
-InvokeConfiguration_SnsParameters_MessageAttribute <Hashtable>
-InvokeConfiguration_SqsParameters_MessageAttribute <Hashtable>
-InvokeConfiguration_SnsParameters_MessageDeduplicationId <String>
-InvokeConfiguration_SqsParameters_MessageDeduplicationId <String>
-InvokeConfiguration_SnsParameters_MessageGroupId <String>
-InvokeConfiguration_SqsParameters_MessageGroupId <String>
-InvokeConfiguration_SnsParameters_MessageStructure <String>
-InvokeConfiguration_SqsParameters_MessageSystemAttribute <Hashtable>
-InvokeConfiguration_EventBusV2Parameters_Metadata <Hashtable>
-InvokeConfiguration_StepFunctionsParameters_Name <String>
-Name <String>
-InvokeConfiguration_KinesisParameters_PartitionKey <String>
-InvokeConfiguration_HttpParameters_PathParameterValue <String[]>
-PointInTimeConfiguration_PointType <PointType>
-InvokeConfiguration_LambdaParameters_Qualifier <String>
-InvokeConfiguration_HttpParameters_QueryStringParameter <Hashtable>
-RetryPolicy_RetryStrategy <RetryStrategy>
-InvokeConfiguration_RoleArn <String>
-PointInTimeConfiguration_StartingPoint <DateTime>
-StartingPosition <StartingPosition>
-State <SubscriberState>
-InvokeConfiguration_SnsParameters_Subject <String>
-Tag <Hashtable>
-InvokeConfiguration_TargetArn <String>
-InvokeConfiguration_LambdaParameters_TenantId <String>
-InvokeConfiguration_StepFunctionsParameters_TraceHeader <String>
-Transformer_Type <TransformerType>
-Type <OrderingType>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonEventBridgeV2Config>

Description

Creates a subscriber on an event bus, which delivers matching events to the configured target. The bus must be ACTIVE. Retries carrying the same ClientToken are idempotent.

Parameters

-BatchConfiguration_MaxBatchSize <Int32>
The maximum number of events to include in a single batch delivered to the target. The service delivers up to this many events per batch; fewer may be delivered when the batch window elapses or the target's per-batch limit is smaller. This is a maximum, not a guaranteed count. Valid range is 1-500 (default: 10, or the target API's per-batch maximum). The resolved value applied by the service is returned on read.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BatchConfiguration_MaxBatchWindowInSecond <Int32>
The maximum time in seconds to wait for a batch to fill before delivering it to the target. This is a maximum; a batch may be delivered sooner if it reaches MaxBatchSize or another delivery condition is met. Valid range is 0-300 (default: 0, meaning no wait). The resolved value applied by the service is always returned on read.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesBatchConfiguration_MaxBatchWindowInSeconds
-ClientConfig <AmazonEventBridgeV2Config>
Amazon.PowerShell.Cmdlets.EVBV2.AmazonEventBridgeV2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EventBusArn <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterConfiguration_Filter <Filter[]>
Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilterConfiguration_Filters
-FilterConfiguration_Language <FilterLanguage>
Defaults to EVENT_BRIDGE_PATTERN when not specified.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvokeConfiguration_EventBusV2Parameters_DeduplicationConfiguration_DeduplicationType <DeduplicationType>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvokeConfiguration_EventBusV2Parameters_Metadata <Hashtable>
Customer-defined metadata forwarded with each event. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvokeConfiguration_EventBusV2Parameters_SystemMetadata_DeduplicationId <String>
Deduplication ID for FIFO deduplication on the downstream bus. Accepts a literal or a JSONata expression.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvokeConfiguration_EventBusV2Parameters_SystemMetadata_EventGroupId <String>
Event group ID for FIFO ordering on the downstream bus. Accepts a literal or a JSONata expression.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvokeConfiguration_HttpParameters_HeaderParameter <Hashtable>
Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInvokeConfiguration_HttpParameters_HeaderParameters
-InvokeConfiguration_HttpParameters_InvocationTimeoutSecond <String>
Timeout in seconds for each invocation of the target (1-30). String-typed (not integer) so the value may be a JSONata expression.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInvokeConfiguration_HttpParameters_InvocationTimeoutSeconds
-InvokeConfiguration_HttpParameters_PathParameterValue <String[]>
Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInvokeConfiguration_HttpParameters_PathParameterValues
-InvokeConfiguration_HttpParameters_QueryStringParameter <Hashtable>
Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInvokeConfiguration_HttpParameters_QueryStringParameters
-InvokeConfiguration_KinesisParameters_ExplicitHashKey <String>
Explicit hash key forwarded to PutRecords unchanged. Accepts JSONata expression.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvokeConfiguration_KinesisParameters_PartitionKey <String>
Required by PutRecords even when an explicit hash key is supplied. Accepts JSONata expression.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvokeConfiguration_LambdaParameters_DurableExecutionName <String>
Durable execution name. Accepts a JSONata expression.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvokeConfiguration_LambdaParameters_InvocationTimeoutSecond <String>
Timeout in seconds for each invocation of the target. String-typed so the value may be a JSONata expression.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInvokeConfiguration_LambdaParameters_InvocationTimeoutSeconds
-InvokeConfiguration_LambdaParameters_InvocationType <InvocationType>
Lambda invocation type. EVENT invokes the function asynchronously; REQUEST_RESPONSE waits for its result.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvokeConfiguration_LambdaParameters_Qualifier <String>
Lambda qualifier: $LATEST, $LATEST.PUBLISHED, a numeric version, or an alias. Accepts a JSONata expression.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvokeConfiguration_LambdaParameters_TenantId <String>
Tenant identifier. Accepts a JSONata expression.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvokeConfiguration_RoleArn <String>
IAM role the service assumes to invoke the target. Must belong to the calling account.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvokeConfiguration_SnsParameters_MessageAttribute <Hashtable>
Custom message attributes for SNS filtering. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInvokeConfiguration_SnsParameters_MessageAttributes
-InvokeConfiguration_SnsParameters_MessageDeduplicationId <String>
Message deduplication ID for FIFO topics. Accepts JSONata expression.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvokeConfiguration_SnsParameters_MessageGroupId <String>
Message group ID for FIFO topics. Accepts JSONata expression.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvokeConfiguration_SnsParameters_MessageStructure <String>
Per-protocol message formatting mode, forwarded to SNS Publish unchanged. Accepts JSONata expression.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvokeConfiguration_SnsParameters_Subject <String>
Subject line for email protocol subscriptions. Accepts JSONata expression.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvokeConfiguration_SqsParameters_DelaySecond <String>
Delay in seconds before the message becomes visible, standard queues only. Accepts JSONata expression.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInvokeConfiguration_SqsParameters_DelaySeconds
-InvokeConfiguration_SqsParameters_MessageAttribute <Hashtable>
Custom message attributes (name/type/value). Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInvokeConfiguration_SqsParameters_MessageAttributes
-InvokeConfiguration_SqsParameters_MessageDeduplicationId <String>
Message deduplication ID for FIFO queues. Accepts JSONata expression.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvokeConfiguration_SqsParameters_MessageGroupId <String>
Message group ID for FIFO queues. Accepts JSONata expression.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvokeConfiguration_SqsParameters_MessageSystemAttribute <Hashtable>
System message attributes (e.g., AWSTraceHeader). Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInvokeConfiguration_SqsParameters_MessageSystemAttributes
-InvokeConfiguration_StepFunctionsParameters_InvocationTimeoutSecond <String>
Timeout in seconds for each invocation of the target (1-30). String-typed (not integer) so the value may be a JSONata expression.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInvokeConfiguration_StepFunctionsParameters_InvocationTimeoutSeconds
-InvokeConfiguration_StepFunctionsParameters_InvocationType <InvocationType>
Selects StartExecution (EVENT) or StartSyncExecution (REQUEST_RESPONSE) at delivery.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvokeConfiguration_StepFunctionsParameters_Name <String>
Name for the execution. Must be unique per account/region/state machine. Accepts JSONata expression.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvokeConfiguration_StepFunctionsParameters_TraceHeader <String>
X-Ray trace header for distributed tracing. Accepts JSONata expression.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvokeConfiguration_TargetArn <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvokeConfiguration_UniversalTargetParameters_Input <String>
JSON string or JSONata expression that produces the API request. Supports {% ... %} JSONata expressions for dynamic values from the event.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvokeConfiguration_UniversalTargetParameters_InvocationTimeoutSecond <String>
Timeout in seconds for each invocation of the target (1-30, default 30). Accepts a literal integer or a {% ... %} JSONata expression evaluated against the event at invocation time. A JSONata expression is syntax-checked at create time. Resolved values outside of the range [1, 30] will be constrained to the nearest bound at delivery time. Defaults to 30 seconds when unset.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInvokeConfiguration_UniversalTargetParameters_InvocationTimeoutSeconds
-LogConfiguration_IncludePayload <IncludePayload>
Whether the customer event payload is embedded in log records. Defaults to ON_ERROR_ONLY.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LogConfiguration_Level <LogLevel>
Minimum log level. Records below this level are not emitted. Defaults to OFF.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-OnFailureConfiguration_Arn <String>
The ARN of the destination that receives events that could not be delivered. An Amazon SQS queue is the supported destination.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PointInTimeConfiguration_EndPoint <DateTime>
Timestamp to stop at. Optional.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PointInTimeConfiguration_PointType <PointType>
Whether to start from the horizon or a specific timestamp.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PointInTimeConfiguration_StartingPoint <DateTime>
Timestamp to start from. Required when PointType is TIMESTAMP.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RetryPolicy_MaxEventAgeInSecond <Int32>
Maximum age of an event in seconds before it is discarded (60-86400, default: 300).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRetryPolicy_MaxEventAgeInSeconds
-RetryPolicy_MaxRetryAttempt <Int32>
Maximum number of retry attempts (0-185, default: 5).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRetryPolicy_MaxRetryAttempts
-RetryPolicy_RetryStrategy <RetryStrategy>
Strategy for determining which exceptions are retried. Default: ALL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EventBridgeV2.Model.CreateSubscriberResponse). Specifying the name of a property of type Amazon.EventBridgeV2.Model.CreateSubscriberResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StartingPosition <StartingPosition>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-State <SubscriberState>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-Transformer_JsonataConfiguration_Expression <String>
JSONata expression to transform the event. Must be wrapped in {% %} delimiters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Transformer_Type <TransformerType>
Transform type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Type <OrderingType>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.EventBridgeV2.Model.CreateSubscriberResponse
This cmdlet returns an Amazon.EventBridgeV2.Model.CreateSubscriberResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z