AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . appsync ]

update-api-cache

Description

Updates the cache for the GraphQL API.

See also: AWS API Documentation

Synopsis

  update-api-cache
--api-id <value>
--ttl <value>
--api-caching-behavior <value>
--type <value>
[--health-metrics-config <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--api-id (string)

The GraphQL API ID.

--ttl (long)

TTL in seconds for cache entries.

Valid values are 1–3,600 seconds.

--api-caching-behavior (string)

Caching behavior.

  • FULL_REQUEST_CACHING : All requests are fully cached.
  • PER_RESOLVER_CACHING : Individual resolvers that you specify are cached.

Possible values:

  • FULL_REQUEST_CACHING
  • PER_RESOLVER_CACHING

--type (string)

The cache instance type. Valid values are

  • SMALL
  • MEDIUM
  • LARGE
  • XLARGE
  • LARGE_2X
  • LARGE_4X
  • LARGE_8X (not available in all regions)
  • LARGE_12X

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

The following legacy instance types are available, but their use is discouraged:

  • T2_SMALL : A t2.small instance type.
  • T2_MEDIUM : A t2.medium instance type.
  • R4_LARGE : A r4.large instance type.
  • R4_XLARGE : A r4.xlarge instance type.
  • R4_2XLARGE : A r4.2xlarge instance type.
  • R4_4XLARGE : A r4.4xlarge instance type.
  • R4_8XLARGE : A r4.8xlarge instance type.

Possible values:

  • T2_SMALL
  • T2_MEDIUM
  • R4_LARGE
  • R4_XLARGE
  • R4_2XLARGE
  • R4_4XLARGE
  • R4_8XLARGE
  • SMALL
  • MEDIUM
  • LARGE
  • XLARGE
  • LARGE_2X
  • LARGE_4X
  • LARGE_8X
  • LARGE_12X

--health-metrics-config (string)

Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:

  • NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache configuration.
  • EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is useful for diagnosing bottlenecks in a cache configuration.

Metrics will be recorded by API ID. You can set the value to ENABLED or DISABLED .

Possible values:

  • ENABLED
  • DISABLED

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

apiCache -> (structure)

The ApiCache object.

ttl -> (long)

TTL in seconds for cache entries.

Valid values are 1–3,600 seconds.

apiCachingBehavior -> (string)

Caching behavior.

  • FULL_REQUEST_CACHING : All requests are fully cached.
  • PER_RESOLVER_CACHING : Individual resolvers that you specify are cached.

transitEncryptionEnabled -> (boolean)

Transit encryption flag when connecting to cache. You cannot update this setting after creation.

atRestEncryptionEnabled -> (boolean)

At-rest encryption flag for cache. You cannot update this setting after creation.

type -> (string)

The cache instance type. Valid values are

  • SMALL
  • MEDIUM
  • LARGE
  • XLARGE
  • LARGE_2X
  • LARGE_4X
  • LARGE_8X (not available in all regions)
  • LARGE_12X

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

The following legacy instance types are available, but their use is discouraged:

  • T2_SMALL : A t2.small instance type.
  • T2_MEDIUM : A t2.medium instance type.
  • R4_LARGE : A r4.large instance type.
  • R4_XLARGE : A r4.xlarge instance type.
  • R4_2XLARGE : A r4.2xlarge instance type.
  • R4_4XLARGE : A r4.4xlarge instance type.
  • R4_8XLARGE : A r4.8xlarge instance type.

status -> (string)

The cache instance status.

  • AVAILABLE : The instance is available for use.
  • CREATING : The instance is currently creating.
  • DELETING : The instance is currently deleting.
  • MODIFYING : The instance is currently modifying.
  • FAILED : The instance has failed creation.

healthMetricsConfig -> (string)

Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:

  • NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache configuration.
  • EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is useful for diagnosing bottlenecks in a cache configuration.

Metrics will be recorded by API ID. You can set the value to ENABLED or DISABLED .