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 AWS Lambda CreateEventSourceMapping API operation.

Syntax

New-LMEventSourceMapping
-FunctionName <String>
-AmazonManagedKafkaEventSourceConfig_SchemaRegistryConfig_AccessConfigs <KafkaSchemaRegistryAccessConfig[]>
-SchemaRegistryConfig_AccessConfig <KafkaSchemaRegistryAccessConfig[]>
-BatchSize <Int32>
-BisectBatchOnFunctionError <Boolean>
-DocumentDBEventSourceConfig_CollectionName <String>
-AmazonManagedKafkaEventSourceConfig_ConsumerGroupId <String>
-SelfManagedKafkaEventSourceConfig_ConsumerGroupId <String>
-DocumentDBEventSourceConfig_DatabaseName <String>
-OnFailure_Destination <String>
-OnSuccess_Destination <String>
-Enabled <Boolean>
-SelfManagedEventSource_Endpoint <Hashtable>
-AmazonManagedKafkaEventSourceConfig_SchemaRegistryConfig_EventRecordFormat <SchemaRegistryEventRecordFormat>
-SchemaRegistryConfig_EventRecordFormat <SchemaRegistryEventRecordFormat>
-EventSourceArn <String>
-FilterCriteria_Filter <Filter[]>
-DocumentDBEventSourceConfig_FullDocument <FullDocument>
-FunctionResponseType <String[]>
-KMSKeyArn <String>
-MaximumBatchingWindowInSecond <Int32>
-ScalingConfig_MaximumConcurrency <Int32>
-ProvisionedPollerConfig_MaximumPoller <Int32>
-MaximumRecordAgeInSecond <Int32>
-MaximumRetryAttempt <Int32>
-MetricsConfig_Metric <String[]>
-ProvisionedPollerConfig_MinimumPoller <Int32>
-ParallelizationFactor <Int32>
-ProvisionedPollerConfig_PollerGroupName <String>
-Queue <String[]>
-AmazonManagedKafkaEventSourceConfig_SchemaRegistryConfig_SchemaRegistryURI <String>
-SchemaRegistryConfig_SchemaRegistryURI <String>
-AmazonManagedKafkaEventSourceConfig_SchemaRegistryConfig_SchemaValidationConfigs <KafkaSchemaValidationConfig[]>
-SchemaRegistryConfig_SchemaValidationConfig <KafkaSchemaValidationConfig[]>
-SourceAccessConfiguration <SourceAccessConfiguration[]>
-StartingPosition <EventSourcePosition>
-StartingPositionTimestamp <DateTime>
-Tag <Hashtable>
-Topic <String[]>
-TumblingWindowInSecond <Int32>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonLambdaConfig>

Description

Creates a mapping between an event source and an Lambda function. Lambda reads items from the event source and invokes the function. For details about how to configure different event sources, see the following topics. The following error handling options are available for stream sources (DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka):
  • BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.
  • MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires
  • MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
  • OnFailure – Send discarded records to an Amazon SQS queue, Amazon SNS topic, Kafka topic, or Amazon S3 bucket. For more information, see Adding a destination.
The following option is available only for DynamoDB and Kinesis event sources:
  • ParallelizationFactor – Process multiple batches from each shard concurrently.
For information about which configuration parameters apply to each event source, see the following topics.

Parameters

-AmazonManagedKafkaEventSourceConfig_ConsumerGroupId <String>
The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AmazonManagedKafkaEventSourceConfig_SchemaRegistryConfig_AccessConfigs <KafkaSchemaRegistryAccessConfig[]>
An array of access configuration objects that tell Lambda how to authenticate with your schema registry. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AmazonManagedKafkaEventSourceConfig_SchemaRegistryConfig_EventRecordFormat <SchemaRegistryEventRecordFormat>
The record format that Lambda delivers to your function after schema validation.
  • Choose JSON to have Lambda deliver the record to your function as a standard JSON object.
  • Choose SOURCE to have Lambda deliver the record to your function in its original source format. Lambda removes all schema metadata, such as the schema ID, before sending the record to your function.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AmazonManagedKafkaEventSourceConfig_SchemaRegistryConfig_SchemaRegistryURI <String>
The URI for your schema registry. The correct URI format depends on the type of schema registry you're using.
  • For Glue schema registries, use the ARN of the registry.
  • For Confluent schema registries, use the URL of the registry.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AmazonManagedKafkaEventSourceConfig_SchemaRegistryConfig_SchemaValidationConfigs <KafkaSchemaValidationConfig[]>
An array of schema validation configuration objects, which tell Lambda the message attributes you want to validate and filter using your schema registry. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BatchSize <Int32>
The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).
  • Amazon Kinesis – Default 100. Max 10,000.
  • Amazon DynamoDB Streams – Default 100. Max 10,000.
  • Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
  • Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.
  • Self-managed Apache Kafka – Default 100. Max 10,000.
  • Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.
  • DocumentDB – Default 100. Max 10,000.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BisectBatchOnFunctionError <Boolean>
(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) If the function returns an error, split the batch in two and retry.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonLambdaConfig>
Amazon.PowerShell.Cmdlets.LM.AmazonLambdaClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DocumentDBEventSourceConfig_CollectionName <String>
The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DocumentDBEventSourceConfig_DatabaseName <String>
The name of the database to consume within the DocumentDB cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DocumentDBEventSourceConfig_FullDocument <FullDocument>
Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Enabled <Boolean>
When true, the event source mapping is active. When false, Lambda pauses polling and invocation.Default: True
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EventSourceArn <String>
The Amazon Resource Name (ARN) of the event source.
  • Amazon Kinesis – The ARN of the data stream or a stream consumer.
  • Amazon DynamoDB Streams – The ARN of the stream.
  • Amazon Simple Queue Service – The ARN of the queue.
  • Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).
  • Amazon MQ – The ARN of the broker.
  • Amazon DocumentDB – The ARN of the DocumentDB change stream.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_Filter <Filter[]>
A list of filters. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilterCriteria_Filters
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FunctionName <String>
The name or ARN of the Lambda function.Name formats
  • Function name – MyFunction.
  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
  • Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
  • Partial ARN – 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-FunctionResponseType <String[]>
(Kinesis, DynamoDB Streams, Amazon MSK, self-managed Apache Kafka, and Amazon SQS) A list of current response type enums applied to the event source mapping. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFunctionResponseTypes
-KMSKeyArn <String>
The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria. By default, Lambda does not encrypt your filter criteria object. Specify this property to encrypt data using your own customer managed key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaximumBatchingWindowInSecond <Int32>
The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.For Kinesis, DynamoDB, and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.Related setting: For Kinesis, DynamoDB, and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaximumBatchingWindowInSeconds
-MaximumRecordAgeInSecond <Int32>
(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records older than the specified age. The default value is infinite (-1).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaximumRecordAgeInSeconds
-MaximumRetryAttempt <Int32>
(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaximumRetryAttempts
-MetricsConfig_Metric <String[]>
The metrics you want your event source mapping to produce. Include EventCount to receive event source mapping metrics related to the number of events processed by your event source mapping. For more information about these metrics, see Event source mapping metrics. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricsConfig_Metrics
-OnFailure_Destination <String>
The Amazon Resource Name (ARN) of the destination resource.To retain records of failed invocations from Kinesis, DynamoDB, self-managed Apache Kafka, or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, Amazon S3 bucket, or Kafka topic as the destination.Amazon SNS destinations have a message size limit of 256 KB. If the combined size of the function request and response payload exceeds the limit, Lambda will drop the payload when sending OnFailure event to the destination. For details on this behavior, refer to Retaining records of asynchronous invocations.To retain records of failed invocations from Kinesis, DynamoDB, self-managed Kafka or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDestinationConfig_OnFailure_Destination
-OnSuccess_Destination <String>
The Amazon Resource Name (ARN) of the destination resource.Amazon SNS destinations have a message size limit of 256 KB. If the combined size of the function request and response payload exceeds the limit, Lambda will drop the payload when sending OnFailure event to the destination. For details on this behavior, refer to Retaining records of asynchronous invocations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDestinationConfig_OnSuccess_Destination
-ParallelizationFactor <Int32>
(Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProvisionedPollerConfig_MaximumPoller <Int32>
The maximum number of event pollers this event source can scale up to. For Amazon SQS events source mappings, default is 200, and minimum value allowed is 2. For Amazon MSK and self-managed Apache Kafka event source mappings, default is 200, and minimum value allowed is 1.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProvisionedPollerConfig_MaximumPollers
-ProvisionedPollerConfig_MinimumPoller <Int32>
The minimum number of event pollers this event source can scale down to. For Amazon SQS events source mappings, default is 2, and minimum 2 required. For Amazon MSK and self-managed Apache Kafka event source mappings, default is 1.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProvisionedPollerConfig_MinimumPollers
-ProvisionedPollerConfig_PollerGroupName <String>
(Amazon MSK and self-managed Apache Kafka) The name of the provisioned poller group. Use this option to group multiple ESMs within the VPC to share Event Poller Unit (EPU) capacity. This option is used to optimize Provisioned mode costs for your ESMs. You can group up to 100 ESMs per poller group and aggregate maximum pollers across all ESMs in a group cannot exceed 2000.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Queue <String[]>
(MQ) The name of the Amazon MQ broker destination queue to consume. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesQueues
-ScalingConfig_MaximumConcurrency <Int32>
Limits the number of concurrent instances that the Amazon SQS event source can invoke.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SchemaRegistryConfig_AccessConfig <KafkaSchemaRegistryAccessConfig[]>
An array of access configuration objects that tell Lambda how to authenticate with your schema registry. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSelfManagedKafkaEventSourceConfig_SchemaRegistryConfig_AccessConfigs
-SchemaRegistryConfig_EventRecordFormat <SchemaRegistryEventRecordFormat>
The record format that Lambda delivers to your function after schema validation.
  • Choose JSON to have Lambda deliver the record to your function as a standard JSON object.
  • Choose SOURCE to have Lambda deliver the record to your function in its original source format. Lambda removes all schema metadata, such as the schema ID, before sending the record to your function.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSelfManagedKafkaEventSourceConfig_SchemaRegistryConfig_EventRecordFormat
-SchemaRegistryConfig_SchemaRegistryURI <String>
The URI for your schema registry. The correct URI format depends on the type of schema registry you're using.
  • For Glue schema registries, use the ARN of the registry.
  • For Confluent schema registries, use the URL of the registry.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSelfManagedKafkaEventSourceConfig_SchemaRegistryConfig_SchemaRegistryURI
-SchemaRegistryConfig_SchemaValidationConfig <KafkaSchemaValidationConfig[]>
An array of schema validation configuration objects, which tell Lambda the message attributes you want to validate and filter using your schema registry. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSelfManagedKafkaEventSourceConfig_SchemaRegistryConfig_SchemaValidationConfigs
-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.Lambda.Model.CreateEventSourceMappingResponse). Specifying the name of a property of type Amazon.Lambda.Model.CreateEventSourceMappingResponse 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)
-SelfManagedEventSource_Endpoint <Hashtable>
The list of bootstrap servers for your Kafka brokers in the following format: "KAFKA_BOOTSTRAP_SERVERS": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"]. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSelfManagedEventSource_Endpoints
-SelfManagedKafkaEventSourceConfig_ConsumerGroupId <String>
The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceAccessConfiguration <SourceAccessConfiguration[]>
An array of authentication protocols or VPC components required to secure your event source. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceAccessConfigurations
-StartingPosition <EventSourcePosition>
The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StartingPositionTimestamp <DateTime>
With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
A list of tags to apply to the event source mapping. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-Topic <String[]>
The name of the Kafka topic. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopics
-TumblingWindowInSecond <Int32>
(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTumblingWindowInSeconds

Common Credential and Region Parameters

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

Outputs

Amazon.Lambda.Model.CreateEventSourceMappingResponse
This cmdlet returns an Amazon.Lambda.Model.CreateEventSourceMappingResponse object containing multiple properties.
Developer Guide
AWS Tools for PowerShell User Guide

Supported Version

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