Class AwsAppSyncGraphQlApiDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionA list of additional authentication providers for the GraphQL API.final String
apiId()
The unique identifier for the API.final String
arn()
The Amazon Resource Name (ARN) of the API.final 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.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AdditionalAuthenticationProviders property.final int
hashCode()
final String
id()
The unique identifier for the API.Specifies the configuration for Lambda function authorization.The Amazon CloudWatch Logs configuration.final String
name()
The API name.Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL API endpoint.static Class
<? extends AwsAppSyncGraphQlApiDetails.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.The Amazon Cognito user pools configuration.final String
The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this GraphQL API, if one exists.final Boolean
Indicates whether to use X-Ray tracing for the GraphQL API.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
apiId
The unique identifier for the API.
- Returns:
- The unique identifier for the API.
-
id
The unique identifier for the API.
- Returns:
- The unique identifier for the API.
-
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
The API name.
- Returns:
- The API name.
-
lambdaAuthorizerConfig
Specifies the configuration for Lambda function authorization.
- Returns:
- Specifies the configuration for Lambda function authorization.
-
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
The Amazon Resource Name (ARN) of the API.
- Returns:
- The Amazon Resource Name (ARN) of the API.
-
userPoolConfig
The Amazon Cognito user pools configuration.
- Returns:
- The Amazon Cognito user pools configuration.
-
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
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<AwsAppSyncGraphQlApiDetails.Builder,
AwsAppSyncGraphQlApiDetails> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-