Class: Aws::SecurityHub::Types::AwsAppSyncGraphQlApiDetails

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb

Overview

Provides details about an AppSync Graph QL API, which lets you query multiple databases, microservices, and APIs from a single GraphQL endpoint.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#additional_authentication_providers ⇒ Array<Types::AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails>

A list of additional authentication providers for the GraphQL API.

Returns:



2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2180

class AwsAppSyncGraphQlApiDetails < Struct.new(
  :api_id,
  :id,
  :open_id_connect_config,
  :name,
  :lambda_authorizer_config,
  :xray_enabled,
  :arn,
  :user_pool_config,
  :authentication_type,
  :log_config,
  :additional_authentication_providers,
  :waf_web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#api_id ⇒ String

The unique identifier for the API.

Returns:

  • (String) 


2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2180

class AwsAppSyncGraphQlApiDetails < Struct.new(
  :api_id,
  :id,
  :open_id_connect_config,
  :name,
  :lambda_authorizer_config,
  :xray_enabled,
  :arn,
  :user_pool_config,
  :authentication_type,
  :log_config,
  :additional_authentication_providers,
  :waf_web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

The Amazon Resource Name (ARN) of the API.

Returns:

  • (String) 


2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2180

class AwsAppSyncGraphQlApiDetails < Struct.new(
  :api_id,
  :id,
  :open_id_connect_config,
  :name,
  :lambda_authorizer_config,
  :xray_enabled,
  :arn,
  :user_pool_config,
  :authentication_type,
  :log_config,
  :additional_authentication_providers,
  :waf_web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#authentication_type ⇒ String

The type of security configuration for your GraphQL API: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

Returns:

  • (String) 


2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2180

class AwsAppSyncGraphQlApiDetails < Struct.new(
  :api_id,
  :id,
  :open_id_connect_config,
  :name,
  :lambda_authorizer_config,
  :xray_enabled,
  :arn,
  :user_pool_config,
  :authentication_type,
  :log_config,
  :additional_authentication_providers,
  :waf_web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The unique identifier for the API.

Returns:

  • (String) 


2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2180

class AwsAppSyncGraphQlApiDetails < Struct.new(
  :api_id,
  :id,
  :open_id_connect_config,
  :name,
  :lambda_authorizer_config,
  :xray_enabled,
  :arn,
  :user_pool_config,
  :authentication_type,
  :log_config,
  :additional_authentication_providers,
  :waf_web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#lambda_authorizer_config ⇒ Types::AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails

Specifies the configuration for Lambda function authorization.

Returns:



2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2180

class AwsAppSyncGraphQlApiDetails < Struct.new(
  :api_id,
  :id,
  :open_id_connect_config,
  :name,
  :lambda_authorizer_config,
  :xray_enabled,
  :arn,
  :user_pool_config,
  :authentication_type,
  :log_config,
  :additional_authentication_providers,
  :waf_web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#log_config ⇒ Types::AwsAppSyncGraphQlApiLogConfigDetails

The Amazon CloudWatch Logs configuration.

Returns:



2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2180

class AwsAppSyncGraphQlApiDetails < Struct.new(
  :api_id,
  :id,
  :open_id_connect_config,
  :name,
  :lambda_authorizer_config,
  :xray_enabled,
  :arn,
  :user_pool_config,
  :authentication_type,
  :log_config,
  :additional_authentication_providers,
  :waf_web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The API name.

Returns:

  • (String) 


2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2180

class AwsAppSyncGraphQlApiDetails < Struct.new(
  :api_id,
  :id,
  :open_id_connect_config,
  :name,
  :lambda_authorizer_config,
  :xray_enabled,
  :arn,
  :user_pool_config,
  :authentication_type,
  :log_config,
  :additional_authentication_providers,
  :waf_web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#open_id_connect_config ⇒ Types::AwsAppSyncGraphQlApiOpenIdConnectConfigDetails

Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL API endpoint.

Returns:



2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2180

class AwsAppSyncGraphQlApiDetails < Struct.new(
  :api_id,
  :id,
  :open_id_connect_config,
  :name,
  :lambda_authorizer_config,
  :xray_enabled,
  :arn,
  :user_pool_config,
  :authentication_type,
  :log_config,
  :additional_authentication_providers,
  :waf_web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#user_pool_config ⇒ Types::AwsAppSyncGraphQlApiUserPoolConfigDetails

The Amazon Cognito user pools configuration.

Returns:



2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2180

class AwsAppSyncGraphQlApiDetails < Struct.new(
  :api_id,
  :id,
  :open_id_connect_config,
  :name,
  :lambda_authorizer_config,
  :xray_enabled,
  :arn,
  :user_pool_config,
  :authentication_type,
  :log_config,
  :additional_authentication_providers,
  :waf_web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#waf_web_acl_arn ⇒ String

The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this GraphQL API, if one exists.

Returns:

  • (String) 


2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2180

class AwsAppSyncGraphQlApiDetails < Struct.new(
  :api_id,
  :id,
  :open_id_connect_config,
  :name,
  :lambda_authorizer_config,
  :xray_enabled,
  :arn,
  :user_pool_config,
  :authentication_type,
  :log_config,
  :additional_authentication_providers,
  :waf_web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end

#xray_enabled ⇒ Boolean

Indicates whether to use X-Ray tracing for the GraphQL API.

Returns:

  • (Boolean) 


2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2180

class AwsAppSyncGraphQlApiDetails < Struct.new(
  :api_id,
  :id,
  :open_id_connect_config,
  :name,
  :lambda_authorizer_config,
  :xray_enabled,
  :arn,
  :user_pool_config,
  :authentication_type,
  :log_config,
  :additional_authentication_providers,
  :waf_web_acl_arn)
  SENSITIVE = []
  include Aws::Structure
end