Class: Aws::AppSync::Types::PutGraphqlApiEnvironmentVariablesRequest

Inherits:

Struct

Object
Struct
Aws::AppSync::Types::PutGraphqlApiEnvironmentVariablesRequest

show all

Defined in:: gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#api_id ⇒ String
The ID of the API to which the environmental variable list will be written.
#environment_variables ⇒ Hash<String,String>
The list of environmental variables to add to the API.

Instance Attribute Details

#api_id ⇒ `String`

The ID of the API to which the environmental variable list will be written.

Returns:

(String)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 3739

class PutGraphqlApiEnvironmentVariablesRequest < Struct.new(
  :api_id,
  :environment_variables)
  SENSITIVE = []
  include Aws::Structure
end

#environment_variables ⇒ `Hash<String,String>`

The list of environmental variables to add to the API.

When creating an environmental variable key-value pair, it must follow the additional constraints below:

Keys must begin with a letter.
Keys must be at least two characters long.
Keys can only contain letters, numbers, and the underscore character (_).
Values can be up to 512 characters long.
You can configure up to 50 key-value pairs in a GraphQL API.

You can create a list of environmental variables by adding it to the environmentVariables payload as a list in the format \{"key1":"value1","key2":"value2", …\}. Note that each call of the PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing environmental variable list of that API. This means the existing environmental variables will be lost. To avoid this, you must include all existing and new environmental variables in the list each time you call this action.