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 AppSync CreateDataSource API operation.

Syntax

New-ASYNDataSource
-Name <String>
-ApiId <String>
-HttpConfig_AuthorizationConfig <AuthorizationConfig>
-OpenSearchServiceConfig_AwsRegion <String>
-Description <String>
-DynamodbConfig <DynamodbDataSourceConfig>
-ElasticsearchConfig <ElasticsearchDataSourceConfig>
-HttpConfig_Endpoint <String>
-OpenSearchServiceConfig_Endpoint <String>
-EventBridgeConfig_EventBusArn <String>
-LambdaConfig <LambdaDataSourceConfig>
-MetricsConfig <DataSourceLevelMetricsConfig>
-RelationalDatabaseConfig_RdsHttpEndpointConfig <RdsHttpEndpointConfig>
-RelationalDatabaseConfig_RelationalDatabaseSourceType <RelationalDatabaseSourceType>
-ServiceRoleArn <String>
-Type <DataSourceType>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonAppSyncConfig>

Description

Creates a DataSource object.

Parameters

-ApiId <String>
The API ID for the GraphQL API for the DataSource.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonAppSyncConfig>
Amazon.PowerShell.Cmdlets.ASYN.AmazonAppSyncClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A description of the DataSource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DynamodbConfig <DynamodbDataSourceConfig>
Amazon DynamoDB settings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ElasticsearchConfig <ElasticsearchDataSourceConfig>
Amazon OpenSearch Service settings.As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. For new data sources, use CreateDataSourceRequest$openSearchServiceConfig to create an OpenSearch data source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EventBridgeConfig_EventBusArn <String>
The ARN of the event bus. For more information about event buses, see Amazon EventBridge event buses.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HttpConfig_AuthorizationConfig <AuthorizationConfig>
The authorization configuration in case the HTTP endpoint requires authorization.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HttpConfig_Endpoint <String>
The HTTP URL endpoint. You can specify either the domain name or IP, and port combination, and the URL scheme must be HTTP or HTTPS. If you don't specify the port, AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LambdaConfig <LambdaDataSourceConfig>
Lambda settings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MetricsConfig <DataSourceLevelMetricsConfig>
Enables or disables enhanced data source metrics for specified data sources. Note that metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However, you can still set its value.metricsConfig can be ENABLED or DISABLED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
A user-supplied name for the DataSource.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-OpenSearchServiceConfig_AwsRegion <String>
The Amazon Web Services Region.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenSearchServiceConfig_Endpoint <String>
The endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RelationalDatabaseConfig_RdsHttpEndpointConfig <RdsHttpEndpointConfig>
Amazon RDS HTTP endpoint settings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RelationalDatabaseConfig_RelationalDatabaseSourceType <RelationalDatabaseSourceType>
Source type for the relational database.
  • RDS_HTTP_ENDPOINT: The relational database source type is an Amazon Relational Database Service (Amazon RDS) HTTP endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'DataSource'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.CreateDataSourceResponse). Specifying the name of a property of type Amazon.AppSync.Model.CreateDataSourceResponse 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)
-ServiceRoleArn <String>
The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source. The system assumes this role when accessing the data source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Type <DataSourceType>
The type of the DataSource.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

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

Outputs

Amazon.AppSync.Model.DataSource or Amazon.AppSync.Model.CreateDataSourceResponse
This cmdlet returns an Amazon.AppSync.Model.DataSource object. The service call response (type Amazon.AppSync.Model.CreateDataSourceResponse) can be returned by specifying '-Select *'.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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