AWS Tools for Windows PowerShell
Command Reference

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

Synopsis

Calls the Amazon EventBridge Pipes CreatePipe API operation.

Syntax

New-PIPESPipe
-Name <String>
-SelfManagedKafkaParameters_AdditionalBootstrapServer <String[]>
-SourceParameters_DynamoDBStreamParameters_DeadLetterConfig_Arn <String>
-SourceParameters_KinesisStreamParameters_DeadLetterConfig_Arn <String>
-AwsvpcConfiguration_AssignPublicIp <AssignPublicIp>
-RetryStrategy_Attempt <Int32>
-SourceParameters_ActiveMQBrokerParameters_Credentials_BasicAuth <String>
-SourceParameters_RabbitMQBrokerParameters_Credentials_BasicAuth <String>
-SourceParameters_SelfManagedKafkaParameters_Credentials_BasicAuth <String>
-ActiveMQBrokerParameters_BatchSize <Int32>
-DynamoDBStreamParameters_BatchSize <Int32>
-KinesisStreamParameters_BatchSize <Int32>
-ManagedStreamingKafkaParameters_BatchSize <Int32>
-RabbitMQBrokerParameters_BatchSize <Int32>
-SelfManagedKafkaParameters_BatchSize <Int32>
-SqsQueueParameters_BatchSize <Int32>
-S3LogDestination_BucketName <String>
-S3LogDestination_BucketOwner <String>
-EcsTaskParameters_CapacityProviderStrategy <CapacityProviderStrategyItem[]>
-SourceParameters_ManagedStreamingKafkaParameters_Credentials_ClientCertificateTlsAuth <String>
-SourceParameters_SelfManagedKafkaParameters_Credentials_ClientCertificateTlsAuth <String>
-ContainerOverrides_Command <String[]>
-ManagedStreamingKafkaParameters_ConsumerGroupID <String>
-SelfManagedKafkaParameters_ConsumerGroupID <String>
-Overrides_ContainerOverride <EcsContainerOverride[]>
-Overrides_Cpu <String>
-RedshiftDataParameters_Database <String>
-RedshiftDataParameters_DbUser <String>
-FirehoseLogDestination_DeliveryStreamArn <String>
-BatchJobParameters_DependsOn <BatchJobDependency[]>
-Description <String>
-DesiredState <RequestedPipeState>
-EventBridgeEventBusParameters_DetailType <String>
-EcsTaskParameters_EnableECSManagedTag <Boolean>
-EcsTaskParameters_EnableExecuteCommand <Boolean>
-EventBridgeEventBusParameters_EndpointId <String>
-Enrichment <String>
-ContainerOverrides_Environment <BatchEnvironmentVariable[]>
-Overrides_ExecutionRoleArn <String>
-FilterCriteria_Filter <Filter[]>
-EcsTaskParameters_Group <String>
-EnrichmentParameters_HttpParameters_HeaderParameters <Hashtable>
-TargetParameters_HttpParameters_HeaderParameters <Hashtable>
-LogConfiguration_IncludeExecutionData <String[]>
-Overrides_InferenceAcceleratorOverride <EcsInferenceAcceleratorOverride[]>
-EnrichmentParameters_InputTemplate <String>
-TargetParameters_InputTemplate <String>
-ContainerOverrides_InstanceType <String>
-LambdaFunctionParameters_InvocationType <PipeTargetInvocationType>
-StepFunctionStateMachineParameters_InvocationType <PipeTargetInvocationType>
-BatchJobParameters_JobDefinition <String>
-BatchJobParameters_JobName <String>
-EcsTaskParameters_LaunchType <LaunchType>
-LogConfiguration_Level <LogLevel>
-CloudwatchLogsLogDestination_LogGroupArn <String>
-CloudWatchLogsParameters_LogStreamName <String>
-ActiveMQBrokerParameters_MaximumBatchingWindowInSecond <Int32>
-DynamoDBStreamParameters_MaximumBatchingWindowInSecond <Int32>
-KinesisStreamParameters_MaximumBatchingWindowInSecond <Int32>
-ManagedStreamingKafkaParameters_MaximumBatchingWindowInSecond <Int32>
-RabbitMQBrokerParameters_MaximumBatchingWindowInSecond <Int32>
-SelfManagedKafkaParameters_MaximumBatchingWindowInSecond <Int32>
-SqsQueueParameters_MaximumBatchingWindowInSecond <Int32>
-DynamoDBStreamParameters_MaximumRecordAgeInSecond <Int32>
-KinesisStreamParameters_MaximumRecordAgeInSecond <Int32>
-DynamoDBStreamParameters_MaximumRetryAttempt <Int32>
-KinesisStreamParameters_MaximumRetryAttempt <Int32>
-Overrides_Memory <String>
-SqsQueueParameters_MessageDeduplicationId <String>
-SqsQueueParameters_MessageGroupId <String>
-DynamoDBStreamParameters_OnPartialBatchItemFailure <OnPartialBatchItemFailureStreams>
-KinesisStreamParameters_OnPartialBatchItemFailure <OnPartialBatchItemFailureStreams>
-S3LogDestination_OutputFormat <S3OutputFormat>
-DynamoDBStreamParameters_ParallelizationFactor <Int32>
-KinesisStreamParameters_ParallelizationFactor <Int32>
-BatchJobParameters_Parameter <Hashtable>
-KinesisStreamParameters_PartitionKey <String>
-EnrichmentParameters_HttpParameters_PathParameterValues <String[]>
-TargetParameters_HttpParameters_PathParameterValues <String[]>
-SageMakerPipelineParameters_PipelineParameterList <SageMakerPipelineParameter[]>
-EcsTaskParameters_PlacementConstraint <PlacementConstraint[]>
-EcsTaskParameters_PlacementStrategy <PlacementStrategy[]>
-EcsTaskParameters_PlatformVersion <String>
-S3LogDestination_Prefix <String>
-EcsTaskParameters_PropagateTag <PropagateTags>
-EnrichmentParameters_HttpParameters_QueryStringParameters <Hashtable>
-TargetParameters_HttpParameters_QueryStringParameters <Hashtable>
-ActiveMQBrokerParameters_QueueName <String>
-RabbitMQBrokerParameters_QueueName <String>
-EcsTaskParameters_ReferenceId <String>
-ContainerOverrides_ResourceRequirement <BatchResourceRequirement[]>
-EventBridgeEventBusParameters_Resource <String[]>
-RoleArn <String>
-Credentials_SaslScram256Auth <String>
-SourceParameters_ManagedStreamingKafkaParameters_Credentials_SaslScram512Auth <String>
-Credentials_SaslScram512Auth <String>
-RedshiftDataParameters_SecretManagerArn <String>
-Vpc_SecurityGroup <String[]>
-AwsvpcConfiguration_SecurityGroup <String[]>
-SelfManagedKafkaParameters_ServerRootCaCertificate <String>
-ArrayProperties_Size <Int32>
-EphemeralStorage_SizeInGiB <Int32>
-Source <String>
-EventBridgeEventBusParameters_Source <String>
-RedshiftDataParameters_Sql <String[]>
-DynamoDBStreamParameters_StartingPosition <DynamoDBStreamStartPosition>
-KinesisStreamParameters_StartingPosition <KinesisStreamStartPosition>
-ManagedStreamingKafkaParameters_StartingPosition <MSKStartPosition>
-SelfManagedKafkaParameters_StartingPosition <SelfManagedKafkaStartPosition>
-KinesisStreamParameters_StartingPositionTimestamp <DateTime>
-RedshiftDataParameters_StatementName <String>
-Vpc_Subnet <String[]>
-AwsvpcConfiguration_Subnet <String[]>
-Tag <Hashtable>
-EcsTaskParameters_Tag <Tag[]>
-Target <String>
-EcsTaskParameters_TaskCount <Int32>
-EcsTaskParameters_TaskDefinitionArn <String>
-Overrides_TaskRoleArn <String>
-EventBridgeEventBusParameters_Time <String>
-CloudWatchLogsParameters_Timestamp <String>
-ManagedStreamingKafkaParameters_TopicName <String>
-SelfManagedKafkaParameters_TopicName <String>
-RabbitMQBrokerParameters_VirtualHost <String>
-RedshiftDataParameters_WithEvent <Boolean>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonPipesConfig>

Description

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

Parameters

-ActiveMQBrokerParameters_BatchSize <Int32>
The maximum number of records to include in each batch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_ActiveMQBrokerParameters_BatchSize
-ActiveMQBrokerParameters_MaximumBatchingWindowInSecond <Int32>
The maximum length of a time to wait for events.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_ActiveMQBrokerParameters_MaximumBatchingWindowInSeconds
-ActiveMQBrokerParameters_QueueName <String>
The name of the destination queue to consume.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_ActiveMQBrokerParameters_QueueName
-ArrayProperties_Size <Int32>
The size of the array, if this is an array batch job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_BatchJobParameters_ArrayProperties_Size
-AwsvpcConfiguration_AssignPublicIp <AssignPublicIp>
Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EcsTaskParameters_NetworkConfiguration_AwsvpcConfiguration_AssignPublicIp
-AwsvpcConfiguration_SecurityGroup <String[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EcsTaskParameters_NetworkConfiguration_AwsvpcConfiguration_SecurityGroups
-AwsvpcConfiguration_Subnet <String[]>
Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EcsTaskParameters_NetworkConfiguration_AwsvpcConfiguration_Subnets
-BatchJobParameters_DependsOn <BatchJobDependency[]>
A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_BatchJobParameters_DependsOn
-BatchJobParameters_JobDefinition <String>
The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_BatchJobParameters_JobDefinition
-BatchJobParameters_JobName <String>
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 (_).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_BatchJobParameters_JobName
-BatchJobParameters_Parameter <Hashtable>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_BatchJobParameters_Parameters
-ClientConfig <AmazonPipesConfig>
Amazon.PowerShell.Cmdlets.PIPES.AmazonPipesClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CloudwatchLogsLogDestination_LogGroupArn <String>
The Amazon Web Services Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogConfiguration_CloudwatchLogsLogDestination_LogGroupArn
-CloudWatchLogsParameters_LogStreamName <String>
The name of the log stream.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_CloudWatchLogsParameters_LogStreamName
-CloudWatchLogsParameters_Timestamp <String>
The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_CloudWatchLogsParameters_Timestamp
-ContainerOverrides_Command <String[]>
The command to send to the container that overrides the default command from the Docker image or the task definition.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_BatchJobParameters_ContainerOverrides_Command
-ContainerOverrides_Environment <BatchEnvironmentVariable[]>
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition.Environment variables cannot start with "Batch". This naming convention is reserved for variables that Batch sets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_BatchJobParameters_ContainerOverrides_Environment
-ContainerOverrides_InstanceType <String>
The instance type to use for a multi-node parallel job.This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_BatchJobParameters_ContainerOverrides_InstanceType
-ContainerOverrides_ResourceRequirement <BatchResourceRequirement[]>
The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_BatchJobParameters_ContainerOverrides_ResourceRequirements
-Credentials_SaslScram256Auth <String>
The ARN of the Secrets Manager secret.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_SelfManagedKafkaParameters_Credentials_SaslScram256Auth
-Credentials_SaslScram512Auth <String>
The ARN of the Secrets Manager secret.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_SelfManagedKafkaParameters_Credentials_SaslScram512Auth
-Description <String>
A description of the pipe.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DesiredState <RequestedPipeState>
The state the pipe should be in.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DynamoDBStreamParameters_BatchSize <Int32>
The maximum number of records to include in each batch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_DynamoDBStreamParameters_BatchSize
-DynamoDBStreamParameters_MaximumBatchingWindowInSecond <Int32>
The maximum length of a time to wait for events.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_DynamoDBStreamParameters_MaximumBatchingWindowInSeconds
-DynamoDBStreamParameters_MaximumRecordAgeInSecond <Int32>
(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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_DynamoDBStreamParameters_MaximumRecordAgeInSeconds
-DynamoDBStreamParameters_MaximumRetryAttempt <Int32>
(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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_DynamoDBStreamParameters_MaximumRetryAttempts
-DynamoDBStreamParameters_OnPartialBatchItemFailure <OnPartialBatchItemFailureStreams>
(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_DynamoDBStreamParameters_OnPartialBatchItemFailure
-DynamoDBStreamParameters_ParallelizationFactor <Int32>
(Streams only) The number of batches to process concurrently from each shard. The default value is 1.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_DynamoDBStreamParameters_ParallelizationFactor
-DynamoDBStreamParameters_StartingPosition <DynamoDBStreamStartPosition>
(Streams only) The position in a stream from which to start reading.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_DynamoDBStreamParameters_StartingPosition
-EcsTaskParameters_CapacityProviderStrategy <CapacityProviderStrategyItem[]>
The capacity provider strategy to use for the task.If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EcsTaskParameters_CapacityProviderStrategy
-EcsTaskParameters_EnableECSManagedTag <Boolean>
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EcsTaskParameters_EnableECSManagedTags
-EcsTaskParameters_EnableExecuteCommand <Boolean>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EcsTaskParameters_EnableExecuteCommand
-EcsTaskParameters_Group <String>
Specifies an Amazon ECS task group for the task. The maximum length is 255 characters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EcsTaskParameters_Group
-EcsTaskParameters_LaunchType <LaunchType>
Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EcsTaskParameters_LaunchType
-EcsTaskParameters_PlacementConstraint <PlacementConstraint[]>
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).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EcsTaskParameters_PlacementConstraints
-EcsTaskParameters_PlacementStrategy <PlacementStrategy[]>
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EcsTaskParameters_PlacementStrategy
-EcsTaskParameters_PlatformVersion <String>
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.This structure is used only if LaunchType is FARGATE. For more information about valid platform versions, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EcsTaskParameters_PlatformVersion
-EcsTaskParameters_PropagateTag <PropagateTags>
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EcsTaskParameters_PropagateTags
-EcsTaskParameters_ReferenceId <String>
The reference ID to use for the task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EcsTaskParameters_ReferenceId
-EcsTaskParameters_Tag <Tag[]>
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EcsTaskParameters_Tags
-EcsTaskParameters_TaskCount <Int32>
The number of tasks to create based on TaskDefinition. The default is 1.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EcsTaskParameters_TaskCount
-EcsTaskParameters_TaskDefinitionArn <String>
The ARN of the task definition to use if the event target is an Amazon ECS task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EcsTaskParameters_TaskDefinitionArn
-Enrichment <String>
The ARN of the enrichment resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnrichmentParameters_HttpParameters_HeaderParameters <Hashtable>
The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEnrichment_HttpParameters_HeaderParameters
-EnrichmentParameters_HttpParameters_PathParameterValues <String[]>
The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEnrichment_HttpParameters_PathParameterValues
-EnrichmentParameters_HttpParameters_QueryStringParameters <Hashtable>
The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEnrichment_HttpParameters_QueryStringParameters
-EnrichmentParameters_InputTemplate <String>
Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.To remove an input template, specify an empty string.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EphemeralStorage_SizeInGiB <Int32>
The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EcsTaskParameters_Overrides_EphemeralStorage_SizeInGiB
-EventBridgeEventBusParameters_DetailType <String>
A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EventBridgeEventBusParameters_DetailType
-EventBridgeEventBusParameters_EndpointId <String>
The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EventBridgeEventBusParameters_EndpointId
-EventBridgeEventBusParameters_Resource <String[]>
Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EventBridgeEventBusParameters_Resources
-EventBridgeEventBusParameters_Source <String>
The source of the event.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EventBridgeEventBusParameters_Source
-EventBridgeEventBusParameters_Time <String>
The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EventBridgeEventBusParameters_Time
-FilterCriteria_Filter <Filter[]>
The event patterns.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_FilterCriteria_Filters
-FirehoseLogDestination_DeliveryStreamArn <String>
Specifies the Amazon Resource Name (ARN) of the Kinesis Data Firehose delivery stream to which EventBridge delivers the pipe log records.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogConfiguration_FirehoseLogDestination_DeliveryStreamArn
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KinesisStreamParameters_BatchSize <Int32>
The maximum number of records to include in each batch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_KinesisStreamParameters_BatchSize
-KinesisStreamParameters_MaximumBatchingWindowInSecond <Int32>
The maximum length of a time to wait for events.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_KinesisStreamParameters_MaximumBatchingWindowInSeconds
-KinesisStreamParameters_MaximumRecordAgeInSecond <Int32>
(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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_KinesisStreamParameters_MaximumRecordAgeInSeconds
-KinesisStreamParameters_MaximumRetryAttempt <Int32>
(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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_KinesisStreamParameters_MaximumRetryAttempts
-KinesisStreamParameters_OnPartialBatchItemFailure <OnPartialBatchItemFailureStreams>
(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_KinesisStreamParameters_OnPartialBatchItemFailure
-KinesisStreamParameters_ParallelizationFactor <Int32>
(Streams only) The number of batches to process concurrently from each shard. The default value is 1.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_KinesisStreamParameters_ParallelizationFactor
-KinesisStreamParameters_PartitionKey <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_KinesisStreamParameters_PartitionKey
-KinesisStreamParameters_StartingPosition <KinesisStreamStartPosition>
(Streams only) The position in a stream from which to start reading.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_KinesisStreamParameters_StartingPosition
-KinesisStreamParameters_StartingPositionTimestamp <DateTime>
With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_KinesisStreamParameters_StartingPositionTimestamp
-LambdaFunctionParameters_InvocationType <PipeTargetInvocationType>
Specify whether to invoke the function synchronously or asynchronously.
  • REQUEST_RESPONSE (default) - Invoke synchronously. This corresponds to the RequestResponse option in the InvocationType parameter for the Lambda Invoke API.
  • FIRE_AND_FORGET - Invoke asynchronously. This corresponds to the Event option in the InvocationType parameter for the Lambda Invoke API.
For more information, see Invocation types in the Amazon EventBridge User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_LambdaFunctionParameters_InvocationType
-LogConfiguration_IncludeExecutionData <String[]>
Specify ON to include the execution data (specifically, the payload and awsRequest fields) in the log messages for this pipe.This applies to all log destinations for the pipe.For more information, see Including execution data in logs in the Amazon EventBridge User Guide.The default is OFF.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LogConfiguration_Level <LogLevel>
The level of logging detail to include. This applies to all log destinations for the pipe.For more information, see Specifying EventBridge Pipes log level in the Amazon EventBridge User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManagedStreamingKafkaParameters_BatchSize <Int32>
The maximum number of records to include in each batch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_ManagedStreamingKafkaParameters_BatchSize
-ManagedStreamingKafkaParameters_ConsumerGroupID <String>
The name of the destination queue to consume.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_ManagedStreamingKafkaParameters_ConsumerGroupID
-ManagedStreamingKafkaParameters_MaximumBatchingWindowInSecond <Int32>
The maximum length of a time to wait for events.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_ManagedStreamingKafkaParameters_MaximumBatchingWindowInSeconds
-ManagedStreamingKafkaParameters_StartingPosition <MSKStartPosition>
(Streams only) The position in a stream from which to start reading.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_ManagedStreamingKafkaParameters_StartingPosition
-ManagedStreamingKafkaParameters_TopicName <String>
The name of the topic that the pipe will read from.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_ManagedStreamingKafkaParameters_TopicName
-Name <String>
The name of the pipe.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Overrides_ContainerOverride <EcsContainerOverride[]>
One or more container overrides that are sent to a task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EcsTaskParameters_Overrides_ContainerOverrides
-Overrides_Cpu <String>
The cpu override for the task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EcsTaskParameters_Overrides_Cpu
-Overrides_ExecutionRoleArn <String>
The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EcsTaskParameters_Overrides_ExecutionRoleArn
-Overrides_InferenceAcceleratorOverride <EcsInferenceAcceleratorOverride[]>
The Elastic Inference accelerator override for the task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EcsTaskParameters_Overrides_InferenceAcceleratorOverrides
-Overrides_Memory <String>
The memory override for the task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EcsTaskParameters_Overrides_Memory
-Overrides_TaskRoleArn <String>
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Role for Tasks in the Amazon Elastic Container Service Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_EcsTaskParameters_Overrides_TaskRoleArn
-PassThru <SwitchParameter>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RabbitMQBrokerParameters_BatchSize <Int32>
The maximum number of records to include in each batch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_RabbitMQBrokerParameters_BatchSize
-RabbitMQBrokerParameters_MaximumBatchingWindowInSecond <Int32>
The maximum length of a time to wait for events.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_RabbitMQBrokerParameters_MaximumBatchingWindowInSeconds
-RabbitMQBrokerParameters_QueueName <String>
The name of the destination queue to consume.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_RabbitMQBrokerParameters_QueueName
-RabbitMQBrokerParameters_VirtualHost <String>
The name of the virtual host associated with the source broker.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_RabbitMQBrokerParameters_VirtualHost
-RedshiftDataParameters_Database <String>
The name of the database. Required when authenticating using temporary credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_RedshiftDataParameters_Database
-RedshiftDataParameters_DbUser <String>
The database user name. Required when authenticating using temporary credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_RedshiftDataParameters_DbUser
-RedshiftDataParameters_SecretManagerArn <String>
The name or ARN of the secret that enables access to the database. Required when authenticating using Secrets Manager.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_RedshiftDataParameters_SecretManagerArn
-RedshiftDataParameters_Sql <String[]>
The SQL statement text to run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_RedshiftDataParameters_Sqls
-RedshiftDataParameters_StatementName <String>
The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_RedshiftDataParameters_StatementName
-RedshiftDataParameters_WithEvent <Boolean>
Indicates whether to send an event back to EventBridge after the SQL statement runs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_RedshiftDataParameters_WithEvent
-RetryStrategy_Attempt <Int32>
The number of times to move a job to the RUNNABLE status. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_BatchJobParameters_RetryStrategy_Attempts
-RoleArn <String>
The ARN of the role that allows the pipe to send data to the target.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3LogDestination_BucketName <String>
Specifies the name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogConfiguration_S3LogDestination_BucketName
-S3LogDestination_BucketOwner <String>
Specifies the Amazon Web Services account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogConfiguration_S3LogDestination_BucketOwner
-S3LogDestination_OutputFormat <S3OutputFormat>
How EventBridge should format the log records.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogConfiguration_S3LogDestination_OutputFormat
-S3LogDestination_Prefix <String>
Specifies any prefix text with which to begin Amazon S3 log object names.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 Organizing objects using prefixes in the Amazon Simple Storage Service User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogConfiguration_S3LogDestination_Prefix
-SageMakerPipelineParameters_PipelineParameterList <SageMakerPipelineParameter[]>
List of Parameter names and values for SageMaker Model Building Pipeline execution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_SageMakerPipelineParameters_PipelineParameterList
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SelfManagedKafkaParameters_AdditionalBootstrapServer <String[]>
An array of server URLs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_SelfManagedKafkaParameters_AdditionalBootstrapServers
-SelfManagedKafkaParameters_BatchSize <Int32>
The maximum number of records to include in each batch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_SelfManagedKafkaParameters_BatchSize
-SelfManagedKafkaParameters_ConsumerGroupID <String>
The name of the destination queue to consume.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_SelfManagedKafkaParameters_ConsumerGroupID
-SelfManagedKafkaParameters_MaximumBatchingWindowInSecond <Int32>
The maximum length of a time to wait for events.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_SelfManagedKafkaParameters_MaximumBatchingWindowInSeconds
-SelfManagedKafkaParameters_ServerRootCaCertificate <String>
The ARN of the Secrets Manager secret used for certification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_SelfManagedKafkaParameters_ServerRootCaCertificate
-SelfManagedKafkaParameters_StartingPosition <SelfManagedKafkaStartPosition>
(Streams only) The position in a stream from which to start reading.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_SelfManagedKafkaParameters_StartingPosition
-SelfManagedKafkaParameters_TopicName <String>
The name of the topic that the pipe will read from.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_SelfManagedKafkaParameters_TopicName
-Source <String>
The ARN of the source resource.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceParameters_ActiveMQBrokerParameters_Credentials_BasicAuth <String>
The ARN of the Secrets Manager secret.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSource_ActiveMQBrokerParameters_Credentials_BasicAuth
-SourceParameters_DynamoDBStreamParameters_DeadLetterConfig_Arn <String>
The ARN of the specified target for the dead-letter queue. For Amazon Kinesis stream and Amazon DynamoDB stream sources, specify either an Amazon SNS topic or Amazon SQS queue ARN.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSource_DynamoDBStream_DeadLetterConfig_Arn
-SourceParameters_KinesisStreamParameters_DeadLetterConfig_Arn <String>
The ARN of the specified target for the dead-letter queue. For Amazon Kinesis stream and Amazon DynamoDB stream sources, specify either an Amazon SNS topic or Amazon SQS queue ARN.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSource_KinesisStream_DeadLetterConfig_Arn
-SourceParameters_ManagedStreamingKafkaParameters_Credentials_ClientCertificateTlsAuth <String>
The ARN of the Secrets Manager secret.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSource_ManagedStreamingKafka_Credentials_ClientCertificateTlsAuth
-SourceParameters_ManagedStreamingKafkaParameters_Credentials_SaslScram512Auth <String>
The ARN of the Secrets Manager secret.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSource_ManagedStreamingKafkaParameters_Credentials_SaslScram512Auth
-SourceParameters_RabbitMQBrokerParameters_Credentials_BasicAuth <String>
The ARN of the Secrets Manager secret.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSource_RabbitMQBrokerParameters_Credentials_BasicAuth
-SourceParameters_SelfManagedKafkaParameters_Credentials_BasicAuth <String>
The ARN of the Secrets Manager secret.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSource_SelfManagedKafkaParameters_Credentials_BasicAuth
-SourceParameters_SelfManagedKafkaParameters_Credentials_ClientCertificateTlsAuth <String>
The ARN of the Secrets Manager secret.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSource_SelfStreamingKafka_Credentials_ClientCertificateTlsAuth
-SqsQueueParameters_BatchSize <Int32>
The maximum number of records to include in each batch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_SqsQueueParameters_BatchSize
-SqsQueueParameters_MaximumBatchingWindowInSecond <Int32>
The maximum length of a time to wait for events.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_SqsQueueParameters_MaximumBatchingWindowInSeconds
-SqsQueueParameters_MessageDeduplicationId <String>
This parameter applies only to FIFO (first-in-first-out) queues.The token used for deduplication of sent messages.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_SqsQueueParameters_MessageDeduplicationId
-SqsQueueParameters_MessageGroupId <String>
The FIFO message group ID to use as the target.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_SqsQueueParameters_MessageGroupId
-StepFunctionStateMachineParameters_InvocationType <PipeTargetInvocationType>
Specify whether to invoke the Step Functions state machine synchronously or asynchronously.
  • REQUEST_RESPONSE (default) - Invoke synchronously. For more information, see StartSyncExecution in the Step Functions API Reference.REQUEST_RESPONSE is not supported for STANDARD state machine workflows.
  • FIRE_AND_FORGET - Invoke asynchronously. For more information, see StartExecution in the Step Functions API Reference.
For more information, see Invocation types in the Amazon EventBridge User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetParameters_StepFunctionStateMachineParameters_InvocationType
-Tag <Hashtable>
The list of key-value pairs to associate with the pipe.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-Target <String>
The ARN of the target resource.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-TargetParameters_HttpParameters_HeaderParameters <Hashtable>
The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_HttpParameters_HeaderParameters
-TargetParameters_HttpParameters_PathParameterValues <String[]>
The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_HttpParameters_PathParameterValues
-TargetParameters_HttpParameters_QueryStringParameters <Hashtable>
The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTarget_HttpParameters_QueryStringParameters
-TargetParameters_InputTemplate <String>
Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.To remove an input template, specify an empty string.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Vpc_SecurityGroup <String[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_SelfManagedKafkaParameters_Vpc_SecurityGroup
-Vpc_Subnet <String[]>
Specifies the subnets associated with the stream. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceParameters_SelfManagedKafkaParameters_Vpc_Subnets

Common Credential and Region Parameters

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

Outputs

This cmdlet returns an Amazon.Pipes.Model.CreatePipeResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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