Package software.amazon.awssdk.services.appsync.model

Class PutGraphqlApiEnvironmentVariablesRequest

    • Method Detail

      • apiId

        public final String apiId()

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

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

      • hasEnvironmentVariables

        public final boolean hasEnvironmentVariables()
        For responses, this returns true if the service returned a value for the EnvironmentVariables property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • environmentVariables

        public final Map<String,​String> environmentVariables()

        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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEnvironmentVariables() method.

        Returns:
        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.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object