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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AwsAppSyncGraphQlApiDetails.Builder,AwsAppSyncGraphQlApiDetails>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.