AWS.Tools.Pipes.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Pipes</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.PIPES.AddPIPESResourceTagCmdlet"> <summary> Assigns one or more tags (key-value pairs) to the specified pipe. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. <para> Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. </para><para> You can use the <c>TagResource</c> action with a pipe that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the pipe. If you specify a tag key that is already associated with the pipe, the new tag value that you specify replaces the previous value for that tag. </para><para> You can associate as many as 50 tags with a pipe. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.AddPIPESResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the pipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.AddPIPESResourceTagCmdlet.Tag"> <summary> <para> <para>The list of key-value pairs associated with the pipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.AddPIPESResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pipes.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.AddPIPESResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.AddPIPESResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIPES.GetPIPESPipeCmdlet"> <summary> Get the information about an existing pipe. For more information about pipes, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html">Amazon EventBridge Pipes</a> in the Amazon EventBridge User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.GetPIPESPipeCmdlet.Name"> <summary> <para> <para>The name of the pipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.GetPIPESPipeCmdlet.Select"> <summary> 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.Pipes.Model.DescribePipeResponse). Specifying the name of a property of type Amazon.Pipes.Model.DescribePipeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.GetPIPESPipeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIPES.GetPIPESPipeListCmdlet"> <summary> Get the pipes associated with this account. For more information about pipes, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html">Amazon EventBridge Pipes</a> in the Amazon EventBridge User Guide.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.GetPIPESPipeListCmdlet.CurrentState"> <summary> <para> <para>The state the pipe is in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.GetPIPESPipeListCmdlet.DesiredState"> <summary> <para> <para>The state the pipe should be in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.GetPIPESPipeListCmdlet.NamePrefix"> <summary> <para> <para>A value that will return a subset of the pipes associated with this account. For example, <c>"NamePrefix": "ABC"</c> will return all endpoints with "ABC" in the name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.GetPIPESPipeListCmdlet.SourcePrefix"> <summary> <para> <para>The prefix matching the pipe source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.GetPIPESPipeListCmdlet.TargetPrefix"> <summary> <para> <para>The prefix matching the pipe target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.GetPIPESPipeListCmdlet.Limit"> <summary> <para> <para>The maximum number of pipes to include in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.GetPIPESPipeListCmdlet.NextToken"> <summary> <para> <para>If <c>nextToken</c> is returned, there are more results available. The value of <c>nextToken</c> 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.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.GetPIPESPipeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Pipes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pipes.Model.ListPipesResponse). Specifying the name of a property of type Amazon.Pipes.Model.ListPipesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.GetPIPESPipeListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NamePrefix parameter. The -PassThru parameter is deprecated, use -Select '^NamePrefix' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.GetPIPESPipeListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIPES.GetPIPESResourceTagCmdlet"> <summary> Displays the tags associated with a pipe. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.GetPIPESResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the pipe for which you want to view tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.GetPIPESResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pipes.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.Pipes.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.GetPIPESResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet"> <summary> Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.SelfManagedKafkaParameters_AdditionalBootstrapServer"> <summary> <para> <para>An array of server URLs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.SourceParameters_DynamoDBStreamParameters_DeadLetterConfig_Arn"> <summary> <para> <para>The ARN of the specified target for the dead-letter queue. </para><para>For Amazon Kinesis stream and Amazon DynamoDB stream sources, specify either an Amazon SNS topic or Amazon SQS queue ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.SourceParameters_KinesisStreamParameters_DeadLetterConfig_Arn"> <summary> <para> <para>The ARN of the specified target for the dead-letter queue. </para><para>For Amazon Kinesis stream and Amazon DynamoDB stream sources, specify either an Amazon SNS topic or Amazon SQS queue ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.AwsvpcConfiguration_AssignPublicIp"> <summary> <para> <para>Specifies whether the task's elastic network interface receives a public IP address. You can specify <c>ENABLED</c> only when <c>LaunchType</c> in <c>EcsParameters</c> is set to <c>FARGATE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.RetryStrategy_Attempt"> <summary> <para> <para>The number of times to move a job to the <c>RUNNABLE</c> status. If the value of <c>attempts</c> is greater than one, the job is retried on failure the same number of attempts as the value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.SourceParameters_ActiveMQBrokerParameters_Credentials_BasicAuth"> <summary> <para> <para>The ARN of the Secrets Manager secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.SourceParameters_RabbitMQBrokerParameters_Credentials_BasicAuth"> <summary> <para> <para>The ARN of the Secrets Manager secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.SourceParameters_SelfManagedKafkaParameters_Credentials_BasicAuth"> <summary> <para> <para>The ARN of the Secrets Manager secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.ActiveMQBrokerParameters_BatchSize"> <summary> <para> <para>The maximum number of records to include in each batch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.DynamoDBStreamParameters_BatchSize"> <summary> <para> <para>The maximum number of records to include in each batch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.KinesisStreamParameters_BatchSize"> <summary> <para> <para>The maximum number of records to include in each batch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.ManagedStreamingKafkaParameters_BatchSize"> <summary> <para> <para>The maximum number of records to include in each batch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.RabbitMQBrokerParameters_BatchSize"> <summary> <para> <para>The maximum number of records to include in each batch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.SelfManagedKafkaParameters_BatchSize"> <summary> <para> <para>The maximum number of records to include in each batch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.SqsQueueParameters_BatchSize"> <summary> <para> <para>The maximum number of records to include in each batch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.S3LogDestination_BucketName"> <summary> <para> <para>Specifies the name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.S3LogDestination_BucketOwner"> <summary> <para> <para>Specifies the Amazon Web Services account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.EcsTaskParameters_CapacityProviderStrategy"> <summary> <para> <para>The capacity provider strategy to use for the task.</para><para>If a <c>capacityProviderStrategy</c> is specified, the <c>launchType</c> parameter must be omitted. If no <c>capacityProviderStrategy</c> or launchType is specified, the <c>defaultCapacityProviderStrategy</c> for the cluster is used. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.SourceParameters_ManagedStreamingKafkaParameters_Credentials_ClientCertificateTlsAuth"> <summary> <para> <para>The ARN of the Secrets Manager secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.SourceParameters_SelfManagedKafkaParameters_Credentials_ClientCertificateTlsAuth"> <summary> <para> <para>The ARN of the Secrets Manager secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.ContainerOverrides_Command"> <summary> <para> <para>The command to send to the container that overrides the default command from the Docker image or the task definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.ManagedStreamingKafkaParameters_ConsumerGroupID"> <summary> <para> <para>The name of the destination queue to consume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.SelfManagedKafkaParameters_ConsumerGroupID"> <summary> <para> <para>The name of the destination queue to consume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.Overrides_ContainerOverride"> <summary> <para> <para>One or more container overrides that are sent to a task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.Overrides_Cpu"> <summary> <para> <para>The cpu override for the task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.RedshiftDataParameters_Database"> <summary> <para> <para>The name of the database. Required when authenticating using temporary credentials.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.RedshiftDataParameters_DbUser"> <summary> <para> <para>The database user name. Required when authenticating using temporary credentials.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.FirehoseLogDestination_DeliveryStreamArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of the Kinesis Data Firehose delivery stream to which EventBridge delivers the pipe log records.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.BatchJobParameters_DependsOn"> <summary> <para> <para>A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a <c>SEQUENTIAL</c> 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 <c>N_TO_N</c> 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.Description"> <summary> <para> <para>A description of the pipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.DesiredState"> <summary> <para> <para>The state the pipe should be in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.EventBridgeEventBusParameters_DetailType"> <summary> <para> <para>A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.EcsTaskParameters_EnableECSManagedTag"> <summary> <para> <para>Specifies whether to enable Amazon ECS managed tags for the task. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging Your Amazon ECS Resources</a> in the Amazon Elastic Container Service Developer Guide. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.EcsTaskParameters_EnableExecuteCommand"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.EventBridgeEventBusParameters_EndpointId"> <summary> <para> <para>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 <c>abcde.veo</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.Enrichment"> <summary> <para> <para>The ARN of the enrichment resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.ContainerOverrides_Environment"> <summary> <para> <para>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.</para><note><para>Environment variables cannot start with "<c>Batch</c>". This naming convention is reserved for variables that Batch sets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.Overrides_ExecutionRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html">Amazon ECS task execution IAM role</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.FilterCriteria_Filter"> <summary> <para> <para>The event patterns.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.EcsTaskParameters_Group"> <summary> <para> <para>Specifies an Amazon ECS task group for the task. The maximum length is 255 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.EnrichmentParameters_HttpParameters_HeaderParameters"> <summary> <para> <para>The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.TargetParameters_HttpParameters_HeaderParameters"> <summary> <para> <para>The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.LogConfiguration_IncludeExecutionData"> <summary> <para> <para>Specify <c>ON</c> to include the execution data (specifically, the <c>payload</c> and <c>awsRequest</c> fields) in the log messages for this pipe.</para><para>This applies to all log destinations for the pipe.</para><para>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-execution-data">Including execution data in logs</a> in the <i>Amazon EventBridge User Guide</i>.</para><para>The default is <c>OFF</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.Overrides_InferenceAcceleratorOverride"> <summary> <para> <para>The Elastic Inference accelerator override for the task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.EnrichmentParameters_InputTemplate"> <summary> <para> <para>Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the enrichment. For more information, see <a href="http://www.rfc-editor.org/rfc/rfc7159.txt">The JavaScript Object Notation (JSON) Data Interchange Format</a>.</para><para>To remove an input template, specify an empty string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.TargetParameters_InputTemplate"> <summary> <para> <para>Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see <a href="http://www.rfc-editor.org/rfc/rfc7159.txt">The JavaScript Object Notation (JSON) Data Interchange Format</a>.</para><para>To remove an input template, specify an empty string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.ContainerOverrides_InstanceType"> <summary> <para> <para>The instance type to use for a multi-node parallel job.</para><note><para>This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.LambdaFunctionParameters_InvocationType"> <summary> <para> <para>Specify whether to invoke the function synchronously or asynchronously.</para><ul><li><para><c>REQUEST_RESPONSE</c> (default) - Invoke synchronously. This corresponds to the <c>RequestResponse</c> option in the <c>InvocationType</c> parameter for the Lambda <a href="https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax">Invoke</a> API.</para></li><li><para><c>FIRE_AND_FORGET</c> - Invoke asynchronously. This corresponds to the <c>Event</c> option in the <c>InvocationType</c> parameter for the Lambda <a href="https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax">Invoke</a> API.</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation">Invocation types</a> in the <i>Amazon EventBridge User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.StepFunctionStateMachineParameters_InvocationType"> <summary> <para> <para>Specify whether to invoke the Step Functions state machine synchronously or asynchronously.</para><ul><li><para><c>REQUEST_RESPONSE</c> (default) - Invoke synchronously. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartSyncExecution.html">StartSyncExecution</a> in the <i>Step Functions API Reference</i>.</para><note><para><c>REQUEST_RESPONSE</c> is not supported for <c>STANDARD</c> state machine workflows.</para></note></li><li><para><c>FIRE_AND_FORGET</c> - Invoke asynchronously. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html">StartExecution</a> in the <i>Step Functions API Reference</i>.</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation">Invocation types</a> in the <i>Amazon EventBridge User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.BatchJobParameters_JobDefinition"> <summary> <para> <para>The job definition used by this job. This value can be one of <c>name</c>, <c>name:revision</c>, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.BatchJobParameters_JobName"> <summary> <para> <para>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 (_).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.EcsTaskParameters_LaunchType"> <summary> <para> <para>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 <c>FARGATE</c> value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html">Fargate on Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.LogConfiguration_Level"> <summary> <para> <para>The level of logging detail to include. This applies to all log destinations for the pipe.</para><para>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-level">Specifying EventBridge Pipes log level</a> in the <i>Amazon EventBridge User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.CloudwatchLogsLogDestination_LogGroupArn"> <summary> <para> <para>The Amazon Web Services Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.CloudWatchLogsParameters_LogStreamName"> <summary> <para> <para>The name of the log stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.ActiveMQBrokerParameters_MaximumBatchingWindowInSecond"> <summary> <para> <para>The maximum length of a time to wait for events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.DynamoDBStreamParameters_MaximumBatchingWindowInSecond"> <summary> <para> <para>The maximum length of a time to wait for events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.KinesisStreamParameters_MaximumBatchingWindowInSecond"> <summary> <para> <para>The maximum length of a time to wait for events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.ManagedStreamingKafkaParameters_MaximumBatchingWindowInSecond"> <summary> <para> <para>The maximum length of a time to wait for events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.RabbitMQBrokerParameters_MaximumBatchingWindowInSecond"> <summary> <para> <para>The maximum length of a time to wait for events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.SelfManagedKafkaParameters_MaximumBatchingWindowInSecond"> <summary> <para> <para>The maximum length of a time to wait for events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.SqsQueueParameters_MaximumBatchingWindowInSecond"> <summary> <para> <para>The maximum length of a time to wait for events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.DynamoDBStreamParameters_MaximumRecordAgeInSecond"> <summary> <para> <para>(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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.KinesisStreamParameters_MaximumRecordAgeInSecond"> <summary> <para> <para>(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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.DynamoDBStreamParameters_MaximumRetryAttempt"> <summary> <para> <para>(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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.KinesisStreamParameters_MaximumRetryAttempt"> <summary> <para> <para>(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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.Overrides_Memory"> <summary> <para> <para>The memory override for the task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.SqsQueueParameters_MessageDeduplicationId"> <summary> <para> <para>This parameter applies only to FIFO (first-in-first-out) queues.</para><para>The token used for deduplication of sent messages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.SqsQueueParameters_MessageGroupId"> <summary> <para> <para>The FIFO message group ID to use as the target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.Name"> <summary> <para> <para>The name of the pipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.DynamoDBStreamParameters_OnPartialBatchItemFailure"> <summary> <para> <para>(Streams only) Define how to handle item process failures. <c>AUTOMATIC_BISECT</c> halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.KinesisStreamParameters_OnPartialBatchItemFailure"> <summary> <para> <para>(Streams only) Define how to handle item process failures. <c>AUTOMATIC_BISECT</c> halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.S3LogDestination_OutputFormat"> <summary> <para> <para>How EventBridge should format the log records.</para><ul><li><para><c>json</c>: JSON </para></li><li><para><c>plain</c>: Plain text</para></li><li><para><c>w3c</c>: <a href="https://www.w3.org/TR/WD-logfile">W3C extended logging file format</a></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.DynamoDBStreamParameters_ParallelizationFactor"> <summary> <para> <para>(Streams only) The number of batches to process concurrently from each shard. The default value is 1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.KinesisStreamParameters_ParallelizationFactor"> <summary> <para> <para>(Streams only) The number of batches to process concurrently from each shard. The default value is 1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.BatchJobParameters_Parameter"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.KinesisStreamParameters_PartitionKey"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.EnrichmentParameters_HttpParameters_PathParameterValues"> <summary> <para> <para>The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.TargetParameters_HttpParameters_PathParameterValues"> <summary> <para> <para>The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.SageMakerPipelineParameters_PipelineParameterList"> <summary> <para> <para>List of Parameter names and values for SageMaker Model Building Pipeline execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.EcsTaskParameters_PlacementConstraint"> <summary> <para> <para>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).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.EcsTaskParameters_PlacementStrategy"> <summary> <para> <para>The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.EcsTaskParameters_PlatformVersion"> <summary> <para> <para>Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as <c>1.1.0</c>.</para><para>This structure is used only if <c>LaunchType</c> is <c>FARGATE</c>. For more information about valid platform versions, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate Platform Versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.S3LogDestination_Prefix"> <summary> <para> <para>Specifies any prefix text with which to begin Amazon S3 log object names.</para><para>You can use prefixes to organize the data that you store in Amazon S3 buckets. A prefix is a string of characters at the beginning of the object key name. A prefix can be any length, subject to the maximum length of the object key name (1,024 bytes). For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Organizing objects using prefixes</a> in the <i>Amazon Simple Storage Service User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.EcsTaskParameters_PropagateTag"> <summary> <para> <para>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 <c>TagResource</c> API action. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.EnrichmentParameters_HttpParameters_QueryStringParameters"> <summary> <para> <para>The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.TargetParameters_HttpParameters_QueryStringParameters"> <summary> <para> <para>The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.ActiveMQBrokerParameters_QueueName"> <summary> <para> <para>The name of the destination queue to consume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.RabbitMQBrokerParameters_QueueName"> <summary> <para> <para>The name of the destination queue to consume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.EcsTaskParameters_ReferenceId"> <summary> <para> <para>The reference ID to use for the task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.ContainerOverrides_ResourceRequirement"> <summary> <para> <para>The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include <c>GPU</c>, <c>MEMORY</c>, and <c>VCPU</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.EventBridgeEventBusParameters_Resource"> <summary> <para> <para>Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.RoleArn"> <summary> <para> <para>The ARN of the role that allows the pipe to send data to the target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.Credentials_SaslScram256Auth"> <summary> <para> <para>The ARN of the Secrets Manager secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.SourceParameters_ManagedStreamingKafkaParameters_Credentials_SaslScram512Auth"> <summary> <para> <para>The ARN of the Secrets Manager secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.Credentials_SaslScram512Auth"> <summary> <para> <para>The ARN of the Secrets Manager secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.RedshiftDataParameters_SecretManagerArn"> <summary> <para> <para>The name or ARN of the secret that enables access to the database. Required when authenticating using Secrets Manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.Vpc_SecurityGroup"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.AwsvpcConfiguration_SecurityGroup"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.SelfManagedKafkaParameters_ServerRootCaCertificate"> <summary> <para> <para>The ARN of the Secrets Manager secret used for certification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.ArrayProperties_Size"> <summary> <para> <para>The size of the array, if this is an array batch job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.EphemeralStorage_SizeInGiB"> <summary> <para> <para>The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is <c>21</c> GiB and the maximum supported value is <c>200</c> GiB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.Source"> <summary> <para> <para>The ARN of the source resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.EventBridgeEventBusParameters_Source"> <summary> <para> <para>The source of the event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.RedshiftDataParameters_Sql"> <summary> <para> <para>The SQL statement text to run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.DynamoDBStreamParameters_StartingPosition"> <summary> <para> <para>(Streams only) The position in a stream from which to start reading.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.KinesisStreamParameters_StartingPosition"> <summary> <para> <para>(Streams only) The position in a stream from which to start reading.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.ManagedStreamingKafkaParameters_StartingPosition"> <summary> <para> <para>(Streams only) The position in a stream from which to start reading.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.SelfManagedKafkaParameters_StartingPosition"> <summary> <para> <para>(Streams only) The position in a stream from which to start reading.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.KinesisStreamParameters_StartingPositionTimestamp"> <summary> <para> <para>With <c>StartingPosition</c> set to <c>AT_TIMESTAMP</c>, the time from which to start reading, in Unix time seconds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.RedshiftDataParameters_StatementName"> <summary> <para> <para>The name of the SQL statement. You can name the SQL statement when you create it to identify the query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.Vpc_Subnet"> <summary> <para> <para>Specifies the subnets associated with the stream. These subnets must all be in the same VPC. You can specify as many as 16 subnets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.AwsvpcConfiguration_Subnet"> <summary> <para> <para>Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.Tag"> <summary> <para> <para>The list of key-value pairs to associate with the pipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.EcsTaskParameters_Tag"> <summary> <para> <para>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 <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags">RunTask</a> in the Amazon ECS API Reference.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.Target"> <summary> <para> <para>The ARN of the target resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.EcsTaskParameters_TaskCount"> <summary> <para> <para>The number of tasks to create based on <c>TaskDefinition</c>. The default is 1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.EcsTaskParameters_TaskDefinitionArn"> <summary> <para> <para>The ARN of the task definition to use if the event target is an Amazon ECS task. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.Overrides_TaskRoleArn"> <summary> <para> <para>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 <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM Role for Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.EventBridgeEventBusParameters_Time"> <summary> <para> <para>The time stamp of the event, per <a href="https://www.rfc-editor.org/rfc/rfc3339.txt">RFC3339</a>. If no time stamp is provided, the time stamp of the <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html">PutEvents</a> call is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.CloudWatchLogsParameters_Timestamp"> <summary> <para> <para>The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.ManagedStreamingKafkaParameters_TopicName"> <summary> <para> <para>The name of the topic that the pipe will read from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.SelfManagedKafkaParameters_TopicName"> <summary> <para> <para>The name of the topic that the pipe will read from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.RabbitMQBrokerParameters_VirtualHost"> <summary> <para> <para>The name of the virtual host associated with the source broker.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.RedshiftDataParameters_WithEvent"> <summary> <para> <para>Indicates whether to send an event back to EventBridge after the SQL statement runs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.Select"> <summary> 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.Pipes.Model.CreatePipeResponse). Specifying the name of a property of type Amazon.Pipes.Model.CreatePipeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.NewPIPESPipeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIPES.RemovePIPESPipeCmdlet"> <summary> Delete an existing pipe. For more information about pipes, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html">Amazon EventBridge Pipes</a> in the Amazon EventBridge User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.RemovePIPESPipeCmdlet.Name"> <summary> <para> <para>The name of the pipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.RemovePIPESPipeCmdlet.Select"> <summary> 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.Pipes.Model.DeletePipeResponse). Specifying the name of a property of type Amazon.Pipes.Model.DeletePipeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.RemovePIPESPipeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.RemovePIPESPipeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIPES.RemovePIPESResourceTagCmdlet"> <summary> Removes one or more tags from the specified pipes. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.RemovePIPESResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the pipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.RemovePIPESResourceTagCmdlet.TagKey"> <summary> <para> <para>The list of tag keys to remove from the pipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.RemovePIPESResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pipes.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.RemovePIPESResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.RemovePIPESResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIPES.StartPIPESPipeCmdlet"> <summary> Start an existing pipe. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.StartPIPESPipeCmdlet.Name"> <summary> <para> <para>The name of the pipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.StartPIPESPipeCmdlet.Select"> <summary> 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.Pipes.Model.StartPipeResponse). Specifying the name of a property of type Amazon.Pipes.Model.StartPipeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.StartPIPESPipeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.StartPIPESPipeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIPES.StopPIPESPipeCmdlet"> <summary> Stop an existing pipe. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.StopPIPESPipeCmdlet.Name"> <summary> <para> <para>The name of the pipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.StopPIPESPipeCmdlet.Select"> <summary> 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.Pipes.Model.StopPipeResponse). Specifying the name of a property of type Amazon.Pipes.Model.StopPipeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.StopPIPESPipeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.StopPIPESPipeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet"> <summary> Update an existing pipe. When you call <c>UpdatePipe</c>, EventBridge only the updates fields you have specified in the request; the rest remain unchanged. The exception to this is if you modify any Amazon Web Services-service specific fields in the <c>SourceParameters</c>, <c>EnrichmentParameters</c>, or <c>TargetParameters</c> objects. For example, <c>DynamoDBStreamParameters</c> or <c>EventBridgeEventBusParameters</c>. EventBridge updates the fields in these objects atomically as one and overrides existing values. This is by design, and means that if you don't specify an optional field in one of these <c>Parameters</c> objects, EventBridge sets that field to its system-default value during the update. <para> For more information about pipes, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html"> Amazon EventBridge Pipes</a> in the Amazon EventBridge User Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.SourceParameters_DynamoDBStreamParameters_DeadLetterConfig_Arn"> <summary> <para> <para>The ARN of the specified target for the dead-letter queue. </para><para>For Amazon Kinesis stream and Amazon DynamoDB stream sources, specify either an Amazon SNS topic or Amazon SQS queue ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.SourceParameters_KinesisStreamParameters_DeadLetterConfig_Arn"> <summary> <para> <para>The ARN of the specified target for the dead-letter queue. </para><para>For Amazon Kinesis stream and Amazon DynamoDB stream sources, specify either an Amazon SNS topic or Amazon SQS queue ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.AwsvpcConfiguration_AssignPublicIp"> <summary> <para> <para>Specifies whether the task's elastic network interface receives a public IP address. You can specify <c>ENABLED</c> only when <c>LaunchType</c> in <c>EcsParameters</c> is set to <c>FARGATE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.RetryStrategy_Attempt"> <summary> <para> <para>The number of times to move a job to the <c>RUNNABLE</c> status. If the value of <c>attempts</c> is greater than one, the job is retried on failure the same number of attempts as the value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.SourceParameters_ActiveMQBrokerParameters_Credentials_BasicAuth"> <summary> <para> <para>The ARN of the Secrets Manager secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.SourceParameters_RabbitMQBrokerParameters_Credentials_BasicAuth"> <summary> <para> <para>The ARN of the Secrets Manager secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.SourceParameters_SelfManagedKafkaParameters_Credentials_BasicAuth"> <summary> <para> <para>The ARN of the Secrets Manager secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.ActiveMQBrokerParameters_BatchSize"> <summary> <para> <para>The maximum number of records to include in each batch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.DynamoDBStreamParameters_BatchSize"> <summary> <para> <para>The maximum number of records to include in each batch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.KinesisStreamParameters_BatchSize"> <summary> <para> <para>The maximum number of records to include in each batch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.ManagedStreamingKafkaParameters_BatchSize"> <summary> <para> <para>The maximum number of records to include in each batch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.RabbitMQBrokerParameters_BatchSize"> <summary> <para> <para>The maximum number of records to include in each batch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.SelfManagedKafkaParameters_BatchSize"> <summary> <para> <para>The maximum number of records to include in each batch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.SqsQueueParameters_BatchSize"> <summary> <para> <para>The maximum number of records to include in each batch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.S3LogDestination_BucketName"> <summary> <para> <para>Specifies the name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.S3LogDestination_BucketOwner"> <summary> <para> <para>Specifies the Amazon Web Services account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.EcsTaskParameters_CapacityProviderStrategy"> <summary> <para> <para>The capacity provider strategy to use for the task.</para><para>If a <c>capacityProviderStrategy</c> is specified, the <c>launchType</c> parameter must be omitted. If no <c>capacityProviderStrategy</c> or launchType is specified, the <c>defaultCapacityProviderStrategy</c> for the cluster is used. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.SourceParameters_ManagedStreamingKafkaParameters_Credentials_ClientCertificateTlsAuth"> <summary> <para> <para>The ARN of the Secrets Manager secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.SourceParameters_SelfManagedKafkaParameters_Credentials_ClientCertificateTlsAuth"> <summary> <para> <para>The ARN of the Secrets Manager secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.ContainerOverrides_Command"> <summary> <para> <para>The command to send to the container that overrides the default command from the Docker image or the task definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.Overrides_ContainerOverride"> <summary> <para> <para>One or more container overrides that are sent to a task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.Overrides_Cpu"> <summary> <para> <para>The cpu override for the task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.RedshiftDataParameters_Database"> <summary> <para> <para>The name of the database. Required when authenticating using temporary credentials.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.RedshiftDataParameters_DbUser"> <summary> <para> <para>The database user name. Required when authenticating using temporary credentials.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.FirehoseLogDestination_DeliveryStreamArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of the Kinesis Data Firehose delivery stream to which EventBridge delivers the pipe log records.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.BatchJobParameters_DependsOn"> <summary> <para> <para>A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a <c>SEQUENTIAL</c> 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 <c>N_TO_N</c> 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.Description"> <summary> <para> <para>A description of the pipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.DesiredState"> <summary> <para> <para>The state the pipe should be in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.EventBridgeEventBusParameters_DetailType"> <summary> <para> <para>A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.EcsTaskParameters_EnableECSManagedTag"> <summary> <para> <para>Specifies whether to enable Amazon ECS managed tags for the task. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging Your Amazon ECS Resources</a> in the Amazon Elastic Container Service Developer Guide. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.EcsTaskParameters_EnableExecuteCommand"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.EventBridgeEventBusParameters_EndpointId"> <summary> <para> <para>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 <c>abcde.veo</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.Enrichment"> <summary> <para> <para>The ARN of the enrichment resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.ContainerOverrides_Environment"> <summary> <para> <para>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.</para><note><para>Environment variables cannot start with "<c>Batch</c>". This naming convention is reserved for variables that Batch sets.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.Overrides_ExecutionRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html">Amazon ECS task execution IAM role</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.FilterCriteria_Filter"> <summary> <para> <para>The event patterns.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.EcsTaskParameters_Group"> <summary> <para> <para>Specifies an Amazon ECS task group for the task. The maximum length is 255 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.EnrichmentParameters_HttpParameters_HeaderParameters"> <summary> <para> <para>The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.TargetParameters_HttpParameters_HeaderParameters"> <summary> <para> <para>The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.LogConfiguration_IncludeExecutionData"> <summary> <para> <para>Specify <c>ON</c> to include the execution data (specifically, the <c>payload</c> and <c>awsRequest</c> fields) in the log messages for this pipe.</para><para>This applies to all log destinations for the pipe.</para><para>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-execution-data">Including execution data in logs</a> in the <i>Amazon EventBridge User Guide</i>.</para><para>The default is <c>OFF</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.Overrides_InferenceAcceleratorOverride"> <summary> <para> <para>The Elastic Inference accelerator override for the task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.EnrichmentParameters_InputTemplate"> <summary> <para> <para>Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the enrichment. For more information, see <a href="http://www.rfc-editor.org/rfc/rfc7159.txt">The JavaScript Object Notation (JSON) Data Interchange Format</a>.</para><para>To remove an input template, specify an empty string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.TargetParameters_InputTemplate"> <summary> <para> <para>Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see <a href="http://www.rfc-editor.org/rfc/rfc7159.txt">The JavaScript Object Notation (JSON) Data Interchange Format</a>.</para><para>To remove an input template, specify an empty string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.ContainerOverrides_InstanceType"> <summary> <para> <para>The instance type to use for a multi-node parallel job.</para><note><para>This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.LambdaFunctionParameters_InvocationType"> <summary> <para> <para>Specify whether to invoke the function synchronously or asynchronously.</para><ul><li><para><c>REQUEST_RESPONSE</c> (default) - Invoke synchronously. This corresponds to the <c>RequestResponse</c> option in the <c>InvocationType</c> parameter for the Lambda <a href="https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax">Invoke</a> API.</para></li><li><para><c>FIRE_AND_FORGET</c> - Invoke asynchronously. This corresponds to the <c>Event</c> option in the <c>InvocationType</c> parameter for the Lambda <a href="https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax">Invoke</a> API.</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation">Invocation types</a> in the <i>Amazon EventBridge User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.StepFunctionStateMachineParameters_InvocationType"> <summary> <para> <para>Specify whether to invoke the Step Functions state machine synchronously or asynchronously.</para><ul><li><para><c>REQUEST_RESPONSE</c> (default) - Invoke synchronously. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartSyncExecution.html">StartSyncExecution</a> in the <i>Step Functions API Reference</i>.</para><note><para><c>REQUEST_RESPONSE</c> is not supported for <c>STANDARD</c> state machine workflows.</para></note></li><li><para><c>FIRE_AND_FORGET</c> - Invoke asynchronously. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html">StartExecution</a> in the <i>Step Functions API Reference</i>.</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation">Invocation types</a> in the <i>Amazon EventBridge User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.BatchJobParameters_JobDefinition"> <summary> <para> <para>The job definition used by this job. This value can be one of <c>name</c>, <c>name:revision</c>, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.BatchJobParameters_JobName"> <summary> <para> <para>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 (_).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.EcsTaskParameters_LaunchType"> <summary> <para> <para>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 <c>FARGATE</c> value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html">Fargate on Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.LogConfiguration_Level"> <summary> <para> <para>The level of logging detail to include. This applies to all log destinations for the pipe.</para><para>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-level">Specifying EventBridge Pipes log level</a> in the <i>Amazon EventBridge User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.CloudwatchLogsLogDestination_LogGroupArn"> <summary> <para> <para>The Amazon Web Services Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.CloudWatchLogsParameters_LogStreamName"> <summary> <para> <para>The name of the log stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.ActiveMQBrokerParameters_MaximumBatchingWindowInSecond"> <summary> <para> <para>The maximum length of a time to wait for events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.DynamoDBStreamParameters_MaximumBatchingWindowInSecond"> <summary> <para> <para>The maximum length of a time to wait for events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.KinesisStreamParameters_MaximumBatchingWindowInSecond"> <summary> <para> <para>The maximum length of a time to wait for events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.ManagedStreamingKafkaParameters_MaximumBatchingWindowInSecond"> <summary> <para> <para>The maximum length of a time to wait for events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.RabbitMQBrokerParameters_MaximumBatchingWindowInSecond"> <summary> <para> <para>The maximum length of a time to wait for events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.SelfManagedKafkaParameters_MaximumBatchingWindowInSecond"> <summary> <para> <para>The maximum length of a time to wait for events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.SqsQueueParameters_MaximumBatchingWindowInSecond"> <summary> <para> <para>The maximum length of a time to wait for events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.DynamoDBStreamParameters_MaximumRecordAgeInSecond"> <summary> <para> <para>(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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.KinesisStreamParameters_MaximumRecordAgeInSecond"> <summary> <para> <para>(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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.DynamoDBStreamParameters_MaximumRetryAttempt"> <summary> <para> <para>(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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.KinesisStreamParameters_MaximumRetryAttempt"> <summary> <para> <para>(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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.Overrides_Memory"> <summary> <para> <para>The memory override for the task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.SqsQueueParameters_MessageDeduplicationId"> <summary> <para> <para>This parameter applies only to FIFO (first-in-first-out) queues.</para><para>The token used for deduplication of sent messages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.SqsQueueParameters_MessageGroupId"> <summary> <para> <para>The FIFO message group ID to use as the target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.Name"> <summary> <para> <para>The name of the pipe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.DynamoDBStreamParameters_OnPartialBatchItemFailure"> <summary> <para> <para>(Streams only) Define how to handle item process failures. <c>AUTOMATIC_BISECT</c> halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.KinesisStreamParameters_OnPartialBatchItemFailure"> <summary> <para> <para>(Streams only) Define how to handle item process failures. <c>AUTOMATIC_BISECT</c> halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.S3LogDestination_OutputFormat"> <summary> <para> <para>How EventBridge should format the log records.</para><ul><li><para><c>json</c>: JSON </para></li><li><para><c>plain</c>: Plain text</para></li><li><para><c>w3c</c>: <a href="https://www.w3.org/TR/WD-logfile">W3C extended logging file format</a></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.DynamoDBStreamParameters_ParallelizationFactor"> <summary> <para> <para>(Streams only) The number of batches to process concurrently from each shard. The default value is 1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.KinesisStreamParameters_ParallelizationFactor"> <summary> <para> <para>(Streams only) The number of batches to process concurrently from each shard. The default value is 1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.BatchJobParameters_Parameter"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.KinesisStreamParameters_PartitionKey"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.EnrichmentParameters_HttpParameters_PathParameterValues"> <summary> <para> <para>The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.TargetParameters_HttpParameters_PathParameterValues"> <summary> <para> <para>The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.SageMakerPipelineParameters_PipelineParameterList"> <summary> <para> <para>List of Parameter names and values for SageMaker Model Building Pipeline execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.EcsTaskParameters_PlacementConstraint"> <summary> <para> <para>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).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.EcsTaskParameters_PlacementStrategy"> <summary> <para> <para>The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.EcsTaskParameters_PlatformVersion"> <summary> <para> <para>Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as <c>1.1.0</c>.</para><para>This structure is used only if <c>LaunchType</c> is <c>FARGATE</c>. For more information about valid platform versions, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate Platform Versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.S3LogDestination_Prefix"> <summary> <para> <para>Specifies any prefix text with which to begin Amazon S3 log object names.</para><para>You can use prefixes to organize the data that you store in Amazon S3 buckets. A prefix is a string of characters at the beginning of the object key name. A prefix can be any length, subject to the maximum length of the object key name (1,024 bytes). For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Organizing objects using prefixes</a> in the <i>Amazon Simple Storage Service User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.EcsTaskParameters_PropagateTag"> <summary> <para> <para>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 <c>TagResource</c> API action. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.EnrichmentParameters_HttpParameters_QueryStringParameters"> <summary> <para> <para>The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.TargetParameters_HttpParameters_QueryStringParameters"> <summary> <para> <para>The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.EcsTaskParameters_ReferenceId"> <summary> <para> <para>The reference ID to use for the task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.ContainerOverrides_ResourceRequirement"> <summary> <para> <para>The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include <c>GPU</c>, <c>MEMORY</c>, and <c>VCPU</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.EventBridgeEventBusParameters_Resource"> <summary> <para> <para>Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.RoleArn"> <summary> <para> <para>The ARN of the role that allows the pipe to send data to the target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.Credentials_SaslScram256Auth"> <summary> <para> <para>The ARN of the Secrets Manager secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.SourceParameters_ManagedStreamingKafkaParameters_Credentials_SaslScram512Auth"> <summary> <para> <para>The ARN of the Secrets Manager secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.Credentials_SaslScram512Auth"> <summary> <para> <para>The ARN of the Secrets Manager secret.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.RedshiftDataParameters_SecretManagerArn"> <summary> <para> <para>The name or ARN of the secret that enables access to the database. Required when authenticating using Secrets Manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.Vpc_SecurityGroup"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.AwsvpcConfiguration_SecurityGroup"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.SelfManagedKafkaParameters_ServerRootCaCertificate"> <summary> <para> <para>The ARN of the Secrets Manager secret used for certification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.ArrayProperties_Size"> <summary> <para> <para>The size of the array, if this is an array batch job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.EphemeralStorage_SizeInGiB"> <summary> <para> <para>The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is <c>21</c> GiB and the maximum supported value is <c>200</c> GiB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.EventBridgeEventBusParameters_Source"> <summary> <para> <para>The source of the event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.RedshiftDataParameters_Sql"> <summary> <para> <para>The SQL statement text to run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.RedshiftDataParameters_StatementName"> <summary> <para> <para>The name of the SQL statement. You can name the SQL statement when you create it to identify the query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.Vpc_Subnet"> <summary> <para> <para>Specifies the subnets associated with the stream. These subnets must all be in the same VPC. You can specify as many as 16 subnets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.AwsvpcConfiguration_Subnet"> <summary> <para> <para>Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.EcsTaskParameters_Tag"> <summary> <para> <para>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 <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags">RunTask</a> in the Amazon ECS API Reference.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.Target"> <summary> <para> <para>The ARN of the target resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.EcsTaskParameters_TaskCount"> <summary> <para> <para>The number of tasks to create based on <c>TaskDefinition</c>. The default is 1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.EcsTaskParameters_TaskDefinitionArn"> <summary> <para> <para>The ARN of the task definition to use if the event target is an Amazon ECS task. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.Overrides_TaskRoleArn"> <summary> <para> <para>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 <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM Role for Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.EventBridgeEventBusParameters_Time"> <summary> <para> <para>The time stamp of the event, per <a href="https://www.rfc-editor.org/rfc/rfc3339.txt">RFC3339</a>. If no time stamp is provided, the time stamp of the <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html">PutEvents</a> call is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.CloudWatchLogsParameters_Timestamp"> <summary> <para> <para>The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.RedshiftDataParameters_WithEvent"> <summary> <para> <para>Indicates whether to send an event back to EventBridge after the SQL statement runs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.Select"> <summary> 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.Pipes.Model.UpdatePipeResponse). Specifying the name of a property of type Amazon.Pipes.Model.UpdatePipeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PIPES.UpdatePIPESPipeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |