@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AwsAppSyncGraphQlApiDetails extends Object implements Serializable, Cloneable, StructuredPojo
Provides details about an AppSync Graph QL API, which lets you query multiple databases, microservices, and APIs from a single GraphQL endpoint.
Constructor and Description |
---|
AwsAppSyncGraphQlApiDetails() |
Modifier and Type | Method and Description |
---|---|
AwsAppSyncGraphQlApiDetails |
clone() |
boolean |
equals(Object obj) |
List<AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails> |
getAdditionalAuthenticationProviders()
A list of additional authentication providers for the GraphQL API.
|
String |
getApiId()
The unique identifier for the API.
|
String |
getArn()
The Amazon Resource Name (ARN) of the API.
|
String |
getAuthenticationType()
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.
|
String |
getId()
The unique identifier for the API.
|
AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails |
getLambdaAuthorizerConfig()
Specifies the configuration for Lambda function authorization.
|
AwsAppSyncGraphQlApiLogConfigDetails |
getLogConfig()
The Amazon CloudWatch Logs configuration.
|
String |
getName()
The API name.
|
AwsAppSyncGraphQlApiOpenIdConnectConfigDetails |
getOpenIdConnectConfig()
Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL
API endpoint.
|
AwsAppSyncGraphQlApiUserPoolConfigDetails |
getUserPoolConfig()
The Amazon Cognito user pools configuration.
|
String |
getWafWebAclArn()
The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this GraphQL API, if
one exists.
|
Boolean |
getXrayEnabled()
Indicates whether to use X-Ray tracing for the GraphQL API.
|
int |
hashCode() |
Boolean |
isXrayEnabled()
Indicates whether to use X-Ray tracing for the GraphQL API.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAdditionalAuthenticationProviders(Collection<AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails> additionalAuthenticationProviders)
A list of additional authentication providers for the GraphQL API.
|
void |
setApiId(String apiId)
The unique identifier for the API.
|
void |
setArn(String arn)
The Amazon Resource Name (ARN) of the API.
|
void |
setAuthenticationType(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.
|
void |
setId(String id)
The unique identifier for the API.
|
void |
setLambdaAuthorizerConfig(AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails lambdaAuthorizerConfig)
Specifies the configuration for Lambda function authorization.
|
void |
setLogConfig(AwsAppSyncGraphQlApiLogConfigDetails logConfig)
The Amazon CloudWatch Logs configuration.
|
void |
setName(String name)
The API name.
|
void |
setOpenIdConnectConfig(AwsAppSyncGraphQlApiOpenIdConnectConfigDetails openIdConnectConfig)
Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL
API endpoint.
|
void |
setUserPoolConfig(AwsAppSyncGraphQlApiUserPoolConfigDetails userPoolConfig)
The Amazon Cognito user pools configuration.
|
void |
setWafWebAclArn(String wafWebAclArn)
The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this GraphQL API, if
one exists.
|
void |
setXrayEnabled(Boolean xrayEnabled)
Indicates whether to use X-Ray tracing for the GraphQL API.
|
String |
toString()
Returns a string representation of this object.
|
AwsAppSyncGraphQlApiDetails |
withAdditionalAuthenticationProviders(AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails... additionalAuthenticationProviders)
A list of additional authentication providers for the GraphQL API.
|
AwsAppSyncGraphQlApiDetails |
withAdditionalAuthenticationProviders(Collection<AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails> additionalAuthenticationProviders)
A list of additional authentication providers for the GraphQL API.
|
AwsAppSyncGraphQlApiDetails |
withApiId(String apiId)
The unique identifier for the API.
|
AwsAppSyncGraphQlApiDetails |
withArn(String arn)
The Amazon Resource Name (ARN) of the API.
|
AwsAppSyncGraphQlApiDetails |
withAuthenticationType(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.
|
AwsAppSyncGraphQlApiDetails |
withId(String id)
The unique identifier for the API.
|
AwsAppSyncGraphQlApiDetails |
withLambdaAuthorizerConfig(AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails lambdaAuthorizerConfig)
Specifies the configuration for Lambda function authorization.
|
AwsAppSyncGraphQlApiDetails |
withLogConfig(AwsAppSyncGraphQlApiLogConfigDetails logConfig)
The Amazon CloudWatch Logs configuration.
|
AwsAppSyncGraphQlApiDetails |
withName(String name)
The API name.
|
AwsAppSyncGraphQlApiDetails |
withOpenIdConnectConfig(AwsAppSyncGraphQlApiOpenIdConnectConfigDetails openIdConnectConfig)
Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL
API endpoint.
|
AwsAppSyncGraphQlApiDetails |
withUserPoolConfig(AwsAppSyncGraphQlApiUserPoolConfigDetails userPoolConfig)
The Amazon Cognito user pools configuration.
|
AwsAppSyncGraphQlApiDetails |
withWafWebAclArn(String wafWebAclArn)
The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this GraphQL API, if
one exists.
|
AwsAppSyncGraphQlApiDetails |
withXrayEnabled(Boolean xrayEnabled)
Indicates whether to use X-Ray tracing for the GraphQL API.
|
public void setApiId(String apiId)
The unique identifier for the API.
apiId
- The unique identifier for the API.public String getApiId()
The unique identifier for the API.
public AwsAppSyncGraphQlApiDetails withApiId(String apiId)
The unique identifier for the API.
apiId
- The unique identifier for the API.public void setId(String id)
The unique identifier for the API.
id
- The unique identifier for the API.public String getId()
The unique identifier for the API.
public AwsAppSyncGraphQlApiDetails withId(String id)
The unique identifier for the API.
id
- The unique identifier for the API.public void setOpenIdConnectConfig(AwsAppSyncGraphQlApiOpenIdConnectConfigDetails openIdConnectConfig)
Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL API endpoint.
openIdConnectConfig
- Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync
GraphQL API endpoint.public AwsAppSyncGraphQlApiOpenIdConnectConfigDetails getOpenIdConnectConfig()
Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL API endpoint.
public AwsAppSyncGraphQlApiDetails withOpenIdConnectConfig(AwsAppSyncGraphQlApiOpenIdConnectConfigDetails openIdConnectConfig)
Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL API endpoint.
openIdConnectConfig
- Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync
GraphQL API endpoint.public void setName(String name)
The API name.
name
- The API name.public String getName()
The API name.
public AwsAppSyncGraphQlApiDetails withName(String name)
The API name.
name
- The API name.public void setLambdaAuthorizerConfig(AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails lambdaAuthorizerConfig)
Specifies the configuration for Lambda function authorization.
lambdaAuthorizerConfig
- Specifies the configuration for Lambda function authorization.public AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails getLambdaAuthorizerConfig()
Specifies the configuration for Lambda function authorization.
public AwsAppSyncGraphQlApiDetails withLambdaAuthorizerConfig(AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails lambdaAuthorizerConfig)
Specifies the configuration for Lambda function authorization.
lambdaAuthorizerConfig
- Specifies the configuration for Lambda function authorization.public void setXrayEnabled(Boolean xrayEnabled)
Indicates whether to use X-Ray tracing for the GraphQL API.
xrayEnabled
- Indicates whether to use X-Ray tracing for the GraphQL API.public Boolean getXrayEnabled()
Indicates whether to use X-Ray tracing for the GraphQL API.
public AwsAppSyncGraphQlApiDetails withXrayEnabled(Boolean xrayEnabled)
Indicates whether to use X-Ray tracing for the GraphQL API.
xrayEnabled
- Indicates whether to use X-Ray tracing for the GraphQL API.public Boolean isXrayEnabled()
Indicates whether to use X-Ray tracing for the GraphQL API.
public void setArn(String arn)
The Amazon Resource Name (ARN) of the API.
arn
- The Amazon Resource Name (ARN) of the API.public String getArn()
The Amazon Resource Name (ARN) of the API.
public AwsAppSyncGraphQlApiDetails withArn(String arn)
The Amazon Resource Name (ARN) of the API.
arn
- The Amazon Resource Name (ARN) of the API.public void setUserPoolConfig(AwsAppSyncGraphQlApiUserPoolConfigDetails userPoolConfig)
The Amazon Cognito user pools configuration.
userPoolConfig
- The Amazon Cognito user pools configuration.public AwsAppSyncGraphQlApiUserPoolConfigDetails getUserPoolConfig()
The Amazon Cognito user pools configuration.
public AwsAppSyncGraphQlApiDetails withUserPoolConfig(AwsAppSyncGraphQlApiUserPoolConfigDetails userPoolConfig)
The Amazon Cognito user pools configuration.
userPoolConfig
- The Amazon Cognito user pools configuration.public void setAuthenticationType(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.
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.public String getAuthenticationType()
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.
public AwsAppSyncGraphQlApiDetails withAuthenticationType(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.
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.public void setLogConfig(AwsAppSyncGraphQlApiLogConfigDetails logConfig)
The Amazon CloudWatch Logs configuration.
logConfig
- The Amazon CloudWatch Logs configuration.public AwsAppSyncGraphQlApiLogConfigDetails getLogConfig()
The Amazon CloudWatch Logs configuration.
public AwsAppSyncGraphQlApiDetails withLogConfig(AwsAppSyncGraphQlApiLogConfigDetails logConfig)
The Amazon CloudWatch Logs configuration.
logConfig
- The Amazon CloudWatch Logs configuration.public List<AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails> getAdditionalAuthenticationProviders()
A list of additional authentication providers for the GraphQL API.
public void setAdditionalAuthenticationProviders(Collection<AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails> additionalAuthenticationProviders)
A list of additional authentication providers for the GraphQL API.
additionalAuthenticationProviders
- A list of additional authentication providers for the GraphQL API.public AwsAppSyncGraphQlApiDetails withAdditionalAuthenticationProviders(AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails... additionalAuthenticationProviders)
A list of additional authentication providers for the GraphQL API.
NOTE: This method appends the values to the existing list (if any). Use
setAdditionalAuthenticationProviders(java.util.Collection)
or
withAdditionalAuthenticationProviders(java.util.Collection)
if you want to override the existing values.
additionalAuthenticationProviders
- A list of additional authentication providers for the GraphQL API.public AwsAppSyncGraphQlApiDetails withAdditionalAuthenticationProviders(Collection<AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails> additionalAuthenticationProviders)
A list of additional authentication providers for the GraphQL API.
additionalAuthenticationProviders
- A list of additional authentication providers for the GraphQL API.public void setWafWebAclArn(String wafWebAclArn)
The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this GraphQL API, if one exists.
wafWebAclArn
- The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this GraphQL
API, if one exists.public String getWafWebAclArn()
The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this GraphQL API, if one exists.
public AwsAppSyncGraphQlApiDetails withWafWebAclArn(String wafWebAclArn)
The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this GraphQL API, if one exists.
wafWebAclArn
- The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this GraphQL
API, if one exists.public String toString()
toString
in class Object
Object.toString()
public AwsAppSyncGraphQlApiDetails clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.