@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GraphqlApi extends Object implements Serializable, Cloneable, StructuredPojo
Describes a GraphQL API.
Constructor and Description |
---|
GraphqlApi() |
Modifier and Type | Method and Description |
---|---|
GraphqlApi |
addDnsEntry(String key,
String value)
Add a single Dns entry
|
GraphqlApi |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
GraphqlApi |
addUrisEntry(String key,
String value)
Add a single Uris entry
|
GraphqlApi |
clearDnsEntries()
Removes all the entries added into Dns.
|
GraphqlApi |
clearTagsEntries()
Removes all the entries added into Tags.
|
GraphqlApi |
clearUrisEntries()
Removes all the entries added into Uris.
|
GraphqlApi |
clone() |
boolean |
equals(Object obj) |
List<AdditionalAuthenticationProvider> |
getAdditionalAuthenticationProviders()
A list of additional authentication providers for the
GraphqlApi API. |
String |
getApiId()
The API ID.
|
String |
getApiType()
The value that indicates whether the GraphQL API is a standard API (
GRAPHQL ) or merged API (
MERGED ). |
String |
getArn()
The Amazon Resource Name (ARN).
|
String |
getAuthenticationType()
The authentication type.
|
Map<String,String> |
getDns()
The DNS records for the API.
|
LambdaAuthorizerConfig |
getLambdaAuthorizerConfig()
Configuration for Lambda function authorization.
|
LogConfig |
getLogConfig()
The Amazon CloudWatch Logs configuration.
|
String |
getMergedApiExecutionRoleArn()
The Identity and Access Management service role ARN for a merged API.
|
String |
getName()
The API name.
|
OpenIDConnectConfig |
getOpenIDConnectConfig()
The OpenID Connect configuration.
|
String |
getOwner()
The account owner of the GraphQL API.
|
String |
getOwnerContact()
The owner contact information for an API resource.
|
Map<String,String> |
getTags()
The tags.
|
Map<String,String> |
getUris()
The URIs.
|
UserPoolConfig |
getUserPoolConfig()
The Amazon Cognito user pool configuration.
|
String |
getVisibility()
Sets the value of the GraphQL API to public (
GLOBAL ) or private (PRIVATE ). |
String |
getWafWebAclArn()
The ARN of the WAF access control list (ACL) associated with this
GraphqlApi , if one exists. |
Boolean |
getXrayEnabled()
A flag indicating whether to use X-Ray tracing for this
GraphqlApi . |
int |
hashCode() |
Boolean |
isXrayEnabled()
A flag indicating whether to use X-Ray tracing for this
GraphqlApi . |
void |
marshall(ProtocolMarshaller protocolMarshaller) |
void |
setAdditionalAuthenticationProviders(Collection<AdditionalAuthenticationProvider> additionalAuthenticationProviders)
A list of additional authentication providers for the
GraphqlApi API. |
void |
setApiId(String apiId)
The API ID.
|
void |
setApiType(String apiType)
The value that indicates whether the GraphQL API is a standard API (
GRAPHQL ) or merged API (
MERGED ). |
void |
setArn(String arn)
The Amazon Resource Name (ARN).
|
void |
setAuthenticationType(String authenticationType)
The authentication type.
|
void |
setDns(Map<String,String> dns)
The DNS records for the API.
|
void |
setLambdaAuthorizerConfig(LambdaAuthorizerConfig lambdaAuthorizerConfig)
Configuration for Lambda function authorization.
|
void |
setLogConfig(LogConfig logConfig)
The Amazon CloudWatch Logs configuration.
|
void |
setMergedApiExecutionRoleArn(String mergedApiExecutionRoleArn)
The Identity and Access Management service role ARN for a merged API.
|
void |
setName(String name)
The API name.
|
void |
setOpenIDConnectConfig(OpenIDConnectConfig openIDConnectConfig)
The OpenID Connect configuration.
|
void |
setOwner(String owner)
The account owner of the GraphQL API.
|
void |
setOwnerContact(String ownerContact)
The owner contact information for an API resource.
|
void |
setTags(Map<String,String> tags)
The tags.
|
void |
setUris(Map<String,String> uris)
The URIs.
|
void |
setUserPoolConfig(UserPoolConfig userPoolConfig)
The Amazon Cognito user pool configuration.
|
void |
setVisibility(String visibility)
Sets the value of the GraphQL API to public (
GLOBAL ) or private (PRIVATE ). |
void |
setWafWebAclArn(String wafWebAclArn)
The ARN of the WAF access control list (ACL) associated with this
GraphqlApi , if one exists. |
void |
setXrayEnabled(Boolean xrayEnabled)
A flag indicating whether to use X-Ray tracing for this
GraphqlApi . |
String |
toString()
Returns a string representation of this object.
|
GraphqlApi |
withAdditionalAuthenticationProviders(AdditionalAuthenticationProvider... additionalAuthenticationProviders)
A list of additional authentication providers for the
GraphqlApi API. |
GraphqlApi |
withAdditionalAuthenticationProviders(Collection<AdditionalAuthenticationProvider> additionalAuthenticationProviders)
A list of additional authentication providers for the
GraphqlApi API. |
GraphqlApi |
withApiId(String apiId)
The API ID.
|
GraphqlApi |
withApiType(GraphQLApiType apiType)
The value that indicates whether the GraphQL API is a standard API (
GRAPHQL ) or merged API (
MERGED ). |
GraphqlApi |
withApiType(String apiType)
The value that indicates whether the GraphQL API is a standard API (
GRAPHQL ) or merged API (
MERGED ). |
GraphqlApi |
withArn(String arn)
The Amazon Resource Name (ARN).
|
GraphqlApi |
withAuthenticationType(AuthenticationType authenticationType)
The authentication type.
|
GraphqlApi |
withAuthenticationType(String authenticationType)
The authentication type.
|
GraphqlApi |
withDns(Map<String,String> dns)
The DNS records for the API.
|
GraphqlApi |
withLambdaAuthorizerConfig(LambdaAuthorizerConfig lambdaAuthorizerConfig)
Configuration for Lambda function authorization.
|
GraphqlApi |
withLogConfig(LogConfig logConfig)
The Amazon CloudWatch Logs configuration.
|
GraphqlApi |
withMergedApiExecutionRoleArn(String mergedApiExecutionRoleArn)
The Identity and Access Management service role ARN for a merged API.
|
GraphqlApi |
withName(String name)
The API name.
|
GraphqlApi |
withOpenIDConnectConfig(OpenIDConnectConfig openIDConnectConfig)
The OpenID Connect configuration.
|
GraphqlApi |
withOwner(String owner)
The account owner of the GraphQL API.
|
GraphqlApi |
withOwnerContact(String ownerContact)
The owner contact information for an API resource.
|
GraphqlApi |
withTags(Map<String,String> tags)
The tags.
|
GraphqlApi |
withUris(Map<String,String> uris)
The URIs.
|
GraphqlApi |
withUserPoolConfig(UserPoolConfig userPoolConfig)
The Amazon Cognito user pool configuration.
|
GraphqlApi |
withVisibility(GraphQLApiVisibility visibility)
Sets the value of the GraphQL API to public (
GLOBAL ) or private (PRIVATE ). |
GraphqlApi |
withVisibility(String visibility)
Sets the value of the GraphQL API to public (
GLOBAL ) or private (PRIVATE ). |
GraphqlApi |
withWafWebAclArn(String wafWebAclArn)
The ARN of the WAF access control list (ACL) associated with this
GraphqlApi , if one exists. |
GraphqlApi |
withXrayEnabled(Boolean xrayEnabled)
A flag indicating whether to use X-Ray tracing for this
GraphqlApi . |
public void setName(String name)
The API name.
name
- The API name.public String getName()
The API name.
public GraphqlApi withName(String name)
The API name.
name
- The API name.public void setApiId(String apiId)
The API ID.
apiId
- The API ID.public String getApiId()
The API ID.
public GraphqlApi withApiId(String apiId)
The API ID.
apiId
- The API ID.public void setAuthenticationType(String authenticationType)
The authentication type.
authenticationType
- The authentication type.AuthenticationType
public String getAuthenticationType()
The authentication type.
AuthenticationType
public GraphqlApi withAuthenticationType(String authenticationType)
The authentication type.
authenticationType
- The authentication type.AuthenticationType
public GraphqlApi withAuthenticationType(AuthenticationType authenticationType)
The authentication type.
authenticationType
- The authentication type.AuthenticationType
public void setLogConfig(LogConfig logConfig)
The Amazon CloudWatch Logs configuration.
logConfig
- The Amazon CloudWatch Logs configuration.public LogConfig getLogConfig()
The Amazon CloudWatch Logs configuration.
public GraphqlApi withLogConfig(LogConfig logConfig)
The Amazon CloudWatch Logs configuration.
logConfig
- The Amazon CloudWatch Logs configuration.public void setUserPoolConfig(UserPoolConfig userPoolConfig)
The Amazon Cognito user pool configuration.
userPoolConfig
- The Amazon Cognito user pool configuration.public UserPoolConfig getUserPoolConfig()
The Amazon Cognito user pool configuration.
public GraphqlApi withUserPoolConfig(UserPoolConfig userPoolConfig)
The Amazon Cognito user pool configuration.
userPoolConfig
- The Amazon Cognito user pool configuration.public void setOpenIDConnectConfig(OpenIDConnectConfig openIDConnectConfig)
The OpenID Connect configuration.
openIDConnectConfig
- The OpenID Connect configuration.public OpenIDConnectConfig getOpenIDConnectConfig()
The OpenID Connect configuration.
public GraphqlApi withOpenIDConnectConfig(OpenIDConnectConfig openIDConnectConfig)
The OpenID Connect configuration.
openIDConnectConfig
- The OpenID Connect configuration.public void setArn(String arn)
The Amazon Resource Name (ARN).
arn
- The Amazon Resource Name (ARN).public String getArn()
The Amazon Resource Name (ARN).
public GraphqlApi withArn(String arn)
The Amazon Resource Name (ARN).
arn
- The Amazon Resource Name (ARN).public GraphqlApi withUris(Map<String,String> uris)
The URIs.
uris
- The URIs.public GraphqlApi addUrisEntry(String key, String value)
public GraphqlApi clearUrisEntries()
public GraphqlApi withTags(Map<String,String> tags)
The tags.
tags
- The tags.public GraphqlApi addTagsEntry(String key, String value)
public GraphqlApi clearTagsEntries()
public List<AdditionalAuthenticationProvider> getAdditionalAuthenticationProviders()
A list of additional authentication providers for the GraphqlApi
API.
GraphqlApi
API.public void setAdditionalAuthenticationProviders(Collection<AdditionalAuthenticationProvider> additionalAuthenticationProviders)
A list of additional authentication providers for the GraphqlApi
API.
additionalAuthenticationProviders
- A list of additional authentication providers for the GraphqlApi
API.public GraphqlApi withAdditionalAuthenticationProviders(AdditionalAuthenticationProvider... additionalAuthenticationProviders)
A list of additional authentication providers for the GraphqlApi
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 GraphqlApi
API.public GraphqlApi withAdditionalAuthenticationProviders(Collection<AdditionalAuthenticationProvider> additionalAuthenticationProviders)
A list of additional authentication providers for the GraphqlApi
API.
additionalAuthenticationProviders
- A list of additional authentication providers for the GraphqlApi
API.public void setXrayEnabled(Boolean xrayEnabled)
A flag indicating whether to use X-Ray tracing for this GraphqlApi
.
xrayEnabled
- A flag indicating whether to use X-Ray tracing for this GraphqlApi
.public Boolean getXrayEnabled()
A flag indicating whether to use X-Ray tracing for this GraphqlApi
.
GraphqlApi
.public GraphqlApi withXrayEnabled(Boolean xrayEnabled)
A flag indicating whether to use X-Ray tracing for this GraphqlApi
.
xrayEnabled
- A flag indicating whether to use X-Ray tracing for this GraphqlApi
.public Boolean isXrayEnabled()
A flag indicating whether to use X-Ray tracing for this GraphqlApi
.
GraphqlApi
.public void setWafWebAclArn(String wafWebAclArn)
The ARN of the WAF access control list (ACL) associated with this GraphqlApi
, if one exists.
wafWebAclArn
- The ARN of the WAF access control list (ACL) associated with this GraphqlApi
, if one exists.public String getWafWebAclArn()
The ARN of the WAF access control list (ACL) associated with this GraphqlApi
, if one exists.
GraphqlApi
, if one exists.public GraphqlApi withWafWebAclArn(String wafWebAclArn)
The ARN of the WAF access control list (ACL) associated with this GraphqlApi
, if one exists.
wafWebAclArn
- The ARN of the WAF access control list (ACL) associated with this GraphqlApi
, if one exists.public void setLambdaAuthorizerConfig(LambdaAuthorizerConfig lambdaAuthorizerConfig)
Configuration for Lambda function authorization.
lambdaAuthorizerConfig
- Configuration for Lambda function authorization.public LambdaAuthorizerConfig getLambdaAuthorizerConfig()
Configuration for Lambda function authorization.
public GraphqlApi withLambdaAuthorizerConfig(LambdaAuthorizerConfig lambdaAuthorizerConfig)
Configuration for Lambda function authorization.
lambdaAuthorizerConfig
- Configuration for Lambda function authorization.public Map<String,String> getDns()
The DNS records for the API.
public void setDns(Map<String,String> dns)
The DNS records for the API.
dns
- The DNS records for the API.public GraphqlApi withDns(Map<String,String> dns)
The DNS records for the API.
dns
- The DNS records for the API.public GraphqlApi addDnsEntry(String key, String value)
public GraphqlApi clearDnsEntries()
public void setVisibility(String visibility)
Sets the value of the GraphQL API to public (GLOBAL
) or private (PRIVATE
). If no value
is provided, the visibility will be set to GLOBAL
by default. This value cannot be changed once the
API has been created.
visibility
- Sets the value of the GraphQL API to public (GLOBAL
) or private (PRIVATE
). If no
value is provided, the visibility will be set to GLOBAL
by default. This value cannot be
changed once the API has been created.GraphQLApiVisibility
public String getVisibility()
Sets the value of the GraphQL API to public (GLOBAL
) or private (PRIVATE
). If no value
is provided, the visibility will be set to GLOBAL
by default. This value cannot be changed once the
API has been created.
GLOBAL
) or private (PRIVATE
). If
no value is provided, the visibility will be set to GLOBAL
by default. This value cannot be
changed once the API has been created.GraphQLApiVisibility
public GraphqlApi withVisibility(String visibility)
Sets the value of the GraphQL API to public (GLOBAL
) or private (PRIVATE
). If no value
is provided, the visibility will be set to GLOBAL
by default. This value cannot be changed once the
API has been created.
visibility
- Sets the value of the GraphQL API to public (GLOBAL
) or private (PRIVATE
). If no
value is provided, the visibility will be set to GLOBAL
by default. This value cannot be
changed once the API has been created.GraphQLApiVisibility
public GraphqlApi withVisibility(GraphQLApiVisibility visibility)
Sets the value of the GraphQL API to public (GLOBAL
) or private (PRIVATE
). If no value
is provided, the visibility will be set to GLOBAL
by default. This value cannot be changed once the
API has been created.
visibility
- Sets the value of the GraphQL API to public (GLOBAL
) or private (PRIVATE
). If no
value is provided, the visibility will be set to GLOBAL
by default. This value cannot be
changed once the API has been created.GraphQLApiVisibility
public void setApiType(String apiType)
The value that indicates whether the GraphQL API is a standard API (GRAPHQL
) or merged API (
MERGED
).
apiType
- The value that indicates whether the GraphQL API is a standard API (GRAPHQL
) or merged API (
MERGED
).GraphQLApiType
public String getApiType()
The value that indicates whether the GraphQL API is a standard API (GRAPHQL
) or merged API (
MERGED
).
GRAPHQL
) or merged API (
MERGED
).GraphQLApiType
public GraphqlApi withApiType(String apiType)
The value that indicates whether the GraphQL API is a standard API (GRAPHQL
) or merged API (
MERGED
).
apiType
- The value that indicates whether the GraphQL API is a standard API (GRAPHQL
) or merged API (
MERGED
).GraphQLApiType
public GraphqlApi withApiType(GraphQLApiType apiType)
The value that indicates whether the GraphQL API is a standard API (GRAPHQL
) or merged API (
MERGED
).
apiType
- The value that indicates whether the GraphQL API is a standard API (GRAPHQL
) or merged API (
MERGED
).GraphQLApiType
public void setMergedApiExecutionRoleArn(String mergedApiExecutionRoleArn)
The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on
behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE
to update the merged API endpoint with the source API changes automatically.
mergedApiExecutionRoleArn
- The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this
role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the
AUTO_MERGE
to update the merged API endpoint with the source API changes automatically.public String getMergedApiExecutionRoleArn()
The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on
behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE
to update the merged API endpoint with the source API changes automatically.
AUTO_MERGE
to update the merged API endpoint with the source API changes automatically.public GraphqlApi withMergedApiExecutionRoleArn(String mergedApiExecutionRoleArn)
The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on
behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE
to update the merged API endpoint with the source API changes automatically.
mergedApiExecutionRoleArn
- The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this
role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the
AUTO_MERGE
to update the merged API endpoint with the source API changes automatically.public void setOwner(String owner)
The account owner of the GraphQL API.
owner
- The account owner of the GraphQL API.public String getOwner()
The account owner of the GraphQL API.
public GraphqlApi withOwner(String owner)
The account owner of the GraphQL API.
owner
- The account owner of the GraphQL API.public void setOwnerContact(String ownerContact)
The owner contact information for an API resource.
This field accepts any string input with a length of 0 - 256 characters.
ownerContact
- The owner contact information for an API resource.
This field accepts any string input with a length of 0 - 256 characters.
public String getOwnerContact()
The owner contact information for an API resource.
This field accepts any string input with a length of 0 - 256 characters.
This field accepts any string input with a length of 0 - 256 characters.
public GraphqlApi withOwnerContact(String ownerContact)
The owner contact information for an API resource.
This field accepts any string input with a length of 0 - 256 characters.
ownerContact
- The owner contact information for an API resource.
This field accepts any string input with a length of 0 - 256 characters.
public String toString()
toString
in class Object
Object.toString()
public GraphqlApi clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
marshall
in interface StructuredPojo
Copyright © 2023. All rights reserved.