Package software.amazon.awssdk.services.securityhub.model

Class AwsAppSyncGraphQlApiDetails

java.lang.Object

software.amazon.awssdk.services.securityhub.model.AwsAppSyncGraphQlApiDetails

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AwsAppSyncGraphQlApiDetails.Builder,AwsAppSyncGraphQlApiDetails>

@Generated("software.amazon.awssdk:codegen")
public final class AwsAppSyncGraphQlApiDetails
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AwsAppSyncGraphQlApiDetails.Builder,AwsAppSyncGraphQlApiDetails>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AwsAppSyncGraphQlApiDetails.Builder

Method Summary

Modifier and Type	Method	Description
List<AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails>	additionalAuthenticationProviders()	A list of additional authentication providers for the GraphQL API.
String	apiId()	The unique identifier for the API.
String	arn()	The Amazon Resource Name (ARN) of the API.
String	authenticationType()	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.
static AwsAppSyncGraphQlApiDetails.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdditionalAuthenticationProviders()	For responses, this returns true if the service returned a value for the AdditionalAuthenticationProviders property.
int	hashCode()
String	id()	The unique identifier for the API.
AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails	lambdaAuthorizerConfig()	Specifies the configuration for Lambda function authorization.
AwsAppSyncGraphQlApiLogConfigDetails	logConfig()	The Amazon CloudWatch Logs configuration.
String	name()	The API name.
AwsAppSyncGraphQlApiOpenIdConnectConfigDetails	openIdConnectConfig()	Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL API endpoint.
List<SdkField<?>>	sdkFields()
static Class<? extends AwsAppSyncGraphQlApiDetails.Builder>	serializableBuilderClass()
AwsAppSyncGraphQlApiDetails.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
AwsAppSyncGraphQlApiUserPoolConfigDetails	userPoolConfig()	The Amazon Cognito user pools configuration.
String	wafWebAclArn()	The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this GraphQL API, if one exists.
Boolean	xrayEnabled()	Indicates whether to use X-Ray tracing for the GraphQL API.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

apiId

public final String apiId()

The unique identifier for the API.

Returns:

The unique identifier for the API.

id

public final String id()

The unique identifier for the API.

Returns:

The unique identifier for the API.

openIdConnectConfig

public final AwsAppSyncGraphQlApiOpenIdConnectConfigDetails openIdConnectConfig()

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

Returns:

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

name

public final String name()

The API name.

Returns:

The API name.

lambdaAuthorizerConfig

public final AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails lambdaAuthorizerConfig()

Specifies the configuration for Lambda function authorization.

Returns:

Specifies the configuration for Lambda function authorization.

xrayEnabled

public final Boolean xrayEnabled()

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

Returns:

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

arn

public final String arn()

The Amazon Resource Name (ARN) of the API.

Returns:

The Amazon Resource Name (ARN) of the API.

userPoolConfig

public final AwsAppSyncGraphQlApiUserPoolConfigDetails userPoolConfig()

The Amazon Cognito user pools configuration.

Returns:

The Amazon Cognito user pools configuration.

authenticationType

public final String authenticationType()

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:

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.

logConfig

public final AwsAppSyncGraphQlApiLogConfigDetails logConfig()

The Amazon CloudWatch Logs configuration.

Returns:

The Amazon CloudWatch Logs configuration.

hasAdditionalAuthenticationProviders

public final boolean hasAdditionalAuthenticationProviders()

For responses, this returns true if the service returned a value for the AdditionalAuthenticationProviders 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.

additionalAuthenticationProviders

public final List<AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails> additionalAuthenticationProviders()

A list of additional authentication providers for the GraphQL API.

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 hasAdditionalAuthenticationProviders() method.

Returns:

A list of additional authentication providers for the GraphQL API.

wafWebAclArn

public final String wafWebAclArn()

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

Returns:

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

toBuilder

public AwsAppSyncGraphQlApiDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AwsAppSyncGraphQlApiDetails.Builder,AwsAppSyncGraphQlApiDetails>

builder

public static AwsAppSyncGraphQlApiDetails.Builder builder()

serializableBuilderClass

public static Class<? extends AwsAppSyncGraphQlApiDetails.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo