[ aws . appsync ]

update-data-source

Description

Updates a DataSource object.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-data-source
--api-id <value>
--name <value>
[--description <value>]
--type <value>
[--service-role-arn <value>]
[--dynamodb-config <value>]
[--lambda-config <value>]
[--elasticsearch-config <value>]
[--http-config <value>]
[--relational-database-config <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--api-id (string)

The API ID.

--name (string)

The new name for the data source.

--description (string)

The new description for the data source.

--type (string)

The new data source type.

Possible values:

• AWS_LAMBDA

• AMAZON_DYNAMODB

• AMAZON_ELASTICSEARCH

• NONE

• HTTP

• RELATIONAL_DATABASE

--service-role-arn (string)

The new service role ARN for the data source.

--dynamodb-config (structure)

The new Amazon DynamoDB configuration.

tableName -> (string)

The table name.

awsRegion -> (string)

The AWS Region.

useCallerCredentials -> (boolean)

Set to TRUE to use Amazon Cognito credentials with this data source.

deltaSyncConfig -> (structure)

The DeltaSyncConfig for a versioned datasource.

baseTableTTL -> (long)

The number of minutes an Item is stored in the datasource.

deltaSyncTableName -> (string)

The Delta Sync table name.

deltaSyncTableTTL -> (long)

The number of minutes a Delta Sync log entry is stored in the Delta Sync table.

versioned -> (boolean)

Set to TRUE to use Conflict Detection and Resolution with this data source.

Shorthand Syntax:

tableName=string,awsRegion=string,useCallerCredentials=boolean,deltaSyncConfig={baseTableTTL=long,deltaSyncTableName=string,deltaSyncTableTTL=long},versioned=boolean

JSON Syntax:

{
  "tableName": "string",
  "awsRegion": "string",
  "useCallerCredentials": true|false,
  "deltaSyncConfig": {
    "baseTableTTL": long,
    "deltaSyncTableName": "string",
    "deltaSyncTableTTL": long
  },
  "versioned": true|false
}

--lambda-config (structure)

The new AWS Lambda configuration.

lambdaFunctionArn -> (string)

The ARN for the Lambda function.

Shorthand Syntax:

lambdaFunctionArn=string

JSON Syntax:

{
  "lambdaFunctionArn": "string"
}

--elasticsearch-config (structure)

The new Elasticsearch Service configuration.

endpoint -> (string)

The endpoint.

awsRegion -> (string)

The AWS Region.

Shorthand Syntax:

endpoint=string,awsRegion=string

JSON Syntax:

{
  "endpoint": "string",
  "awsRegion": "string"
}

--http-config (structure)

The new HTTP endpoint configuration.

endpoint -> (string)

The HTTP URL endpoint. You can either specify the domain name or IP, and port combination, and the URL scheme must be HTTP or HTTPS. If the port is not specified, AWS AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.

authorizationConfig -> (structure)

The authorization config in case the HTTP endpoint requires authorization.

authorizationType -> (string)

The authorization type required by the HTTP endpoint.

• AWS_IAM : The authorization type is Sigv4.

awsIamConfig -> (structure)

The AWS IAM settings.

signingRegion -> (string)

The signing region for AWS IAM authorization.

signingServiceName -> (string)

The signing service name for AWS IAM authorization.

Shorthand Syntax:

endpoint=string,authorizationConfig={authorizationType=string,awsIamConfig={signingRegion=string,signingServiceName=string}}

JSON Syntax:

{
  "endpoint": "string",
  "authorizationConfig": {
    "authorizationType": "AWS_IAM",
    "awsIamConfig": {
      "signingRegion": "string",
      "signingServiceName": "string"
    }
  }
}

--relational-database-config (structure)

The new relational database configuration.

relationalDatabaseSourceType -> (string)

Source type for the relational database.

• RDS_HTTP_ENDPOINT : The relational database source type is an Amazon RDS HTTP endpoint.

rdsHttpEndpointConfig -> (structure)

Amazon RDS HTTP endpoint settings.

awsRegion -> (string)

AWS Region for RDS HTTP endpoint.

dbClusterIdentifier -> (string)

Amazon RDS cluster ARN.

databaseName -> (string)

Logical database name.

schema -> (string)

Logical schema name.

awsSecretStoreArn -> (string)

AWS secret store ARN for database credentials.

Shorthand Syntax:

relationalDatabaseSourceType=string,rdsHttpEndpointConfig={awsRegion=string,dbClusterIdentifier=string,databaseName=string,schema=string,awsSecretStoreArn=string}

JSON Syntax:

{
  "relationalDatabaseSourceType": "RDS_HTTP_ENDPOINT",
  "rdsHttpEndpointConfig": {
    "awsRegion": "string",
    "dbClusterIdentifier": "string",
    "databaseName": "string",
    "schema": "string",
    "awsSecretStoreArn": "string"
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

dataSource -> (structure)

The updated DataSource object.

dataSourceArn -> (string)

The data source ARN.

name -> (string)

The name of the data source.

description -> (string)

The description of the data source.

type -> (string)

The type of the data source.

• AMAZON_DYNAMODB : The data source is an Amazon DynamoDB table.

• AMAZON_ELASTICSEARCH : The data source is an Amazon Elasticsearch Service domain.

• AWS_LAMBDA : The data source is an AWS Lambda function.

• NONE : There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.

• HTTP : The data source is an HTTP endpoint.

• RELATIONAL_DATABASE : The data source is a relational database.

serviceRoleArn -> (string)

The AWS IAM service role ARN for the data source. The system assumes this role when accessing the data source.

dynamodbConfig -> (structure)

Amazon DynamoDB settings.

tableName -> (string)

The table name.

awsRegion -> (string)

The AWS Region.

useCallerCredentials -> (boolean)

Set to TRUE to use Amazon Cognito credentials with this data source.

deltaSyncConfig -> (structure)

The DeltaSyncConfig for a versioned datasource.

baseTableTTL -> (long)

The number of minutes an Item is stored in the datasource.

deltaSyncTableName -> (string)

The Delta Sync table name.

deltaSyncTableTTL -> (long)

The number of minutes a Delta Sync log entry is stored in the Delta Sync table.

versioned -> (boolean)

Set to TRUE to use Conflict Detection and Resolution with this data source.

lambdaConfig -> (structure)

AWS Lambda settings.

lambdaFunctionArn -> (string)

The ARN for the Lambda function.

elasticsearchConfig -> (structure)

Amazon Elasticsearch Service settings.

endpoint -> (string)

The endpoint.

awsRegion -> (string)

The AWS Region.

httpConfig -> (structure)

HTTP endpoint settings.

endpoint -> (string)

The HTTP URL endpoint. You can either specify the domain name or IP, and port combination, and the URL scheme must be HTTP or HTTPS. If the port is not specified, AWS AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.

authorizationConfig -> (structure)

The authorization config in case the HTTP endpoint requires authorization.

authorizationType -> (string)

The authorization type required by the HTTP endpoint.

• AWS_IAM : The authorization type is Sigv4.

awsIamConfig -> (structure)

The AWS IAM settings.

signingRegion -> (string)

The signing region for AWS IAM authorization.

signingServiceName -> (string)

The signing service name for AWS IAM authorization.

relationalDatabaseConfig -> (structure)

Relational database settings.

relationalDatabaseSourceType -> (string)

Source type for the relational database.

• RDS_HTTP_ENDPOINT : The relational database source type is an Amazon RDS HTTP endpoint.

rdsHttpEndpointConfig -> (structure)

Amazon RDS HTTP endpoint settings.

awsRegion -> (string)

AWS Region for RDS HTTP endpoint.

dbClusterIdentifier -> (string)

Amazon RDS cluster ARN.

databaseName -> (string)

Logical database name.

schema -> (string)

Logical schema name.

awsSecretStoreArn -> (string)

AWS secret store ARN for database credentials.