You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::AppSync::Types::CreateGraphqlApiRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateGraphqlApiRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "String", # required
  log_config: {
    field_log_level: "NONE", # required, accepts NONE, ERROR, ALL
    cloud_watch_logs_role_arn: "String", # required
    exclude_verbose_content: false,
  },
  authentication_type: "API_KEY", # required, accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
  user_pool_config: {
    user_pool_id: "String", # required
    aws_region: "String", # required
    default_action: "ALLOW", # required, accepts ALLOW, DENY
    app_id_client_regex: "String",
  },
  open_id_connect_config: {
    issuer: "String", # required
    client_id: "String",
    iat_ttl: 1,
    auth_ttl: 1,
  },
  tags: {
    "TagKey" => "TagValue",
  },
  additional_authentication_providers: [
    {
      authentication_type: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
      open_id_connect_config: {
        issuer: "String", # required
        client_id: "String",
        iat_ttl: 1,
        auth_ttl: 1,
      },
      user_pool_config: {
        user_pool_id: "String", # required
        aws_region: "String", # required
        app_id_client_regex: "String",
      },
    },
  ],
  xray_enabled: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#additional_authentication_providers ⇒ Array<Types::AdditionalAuthenticationProvider>

A list of additional authentication providers for the GraphqlApi API.

Returns:

#authentication_type ⇒ String

The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.

Possible values:

  • API_KEY
  • AWS_IAM
  • AMAZON_COGNITO_USER_POOLS
  • OPENID_CONNECT

Returns:

  • (String) —

    The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.

#log_config ⇒ Types::LogConfig

The Amazon CloudWatch Logs configuration.

Returns:

#name ⇒ String

A user-supplied name for the GraphqlApi.

Returns:

  • (String) —

    A user-supplied name for the GraphqlApi.

#open_id_connect_config ⇒ Types::OpenIDConnectConfig

The OpenID Connect configuration.

Returns:

#tags ⇒ Hash<String,String>

A TagMap object.

Returns:

  • (Hash<String,String>) —

    A TagMap object.

#user_pool_config ⇒ Types::UserPoolConfig

The Amazon Cognito user pool configuration.

Returns:

#xray_enabled ⇒ Boolean

A flag indicating whether to enable X-Ray tracing for the GraphqlApi.

Returns:

  • (Boolean) —

    A flag indicating whether to enable X-Ray tracing for the GraphqlApi.