com.amazonaws.services.appsync.model

Class CreateGraphqlApiRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.appsync.model.CreateGraphqlApiRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateGraphqlApiRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateGraphqlApiRequest()

Method Summary

Modifier and Type	Method and Description
CreateGraphqlApiRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateGraphqlApiRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateGraphqlApiRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<AdditionalAuthenticationProvider>	getAdditionalAuthenticationProviders() A list of additional authentication providers for the GraphqlApi API.
String	getApiType() The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).
String	getAuthenticationType() The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
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() A user-supplied name for the GraphqlApi.
OpenIDConnectConfig	getOpenIDConnectConfig() The OIDC configuration.
String	getOwnerContact() The owner contact information for an API resource.
Map<String,String>	getTags() A TagMap object.
UserPoolConfig	getUserPoolConfig() The Amazon Cognito user pool configuration.
String	getVisibility() Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE).
Boolean	getXrayEnabled() A flag indicating whether to use X-Ray tracing for the GraphqlApi.
int	hashCode()
Boolean	isXrayEnabled() A flag indicating whether to use X-Ray tracing for the GraphqlApi.
void	setAdditionalAuthenticationProviders(Collection<AdditionalAuthenticationProvider> additionalAuthenticationProviders) A list of additional authentication providers for the GraphqlApi API.
void	setApiType(String apiType) The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).
void	setAuthenticationType(String authenticationType) The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
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) A user-supplied name for the GraphqlApi.
void	setOpenIDConnectConfig(OpenIDConnectConfig openIDConnectConfig) The OIDC configuration.
void	setOwnerContact(String ownerContact) The owner contact information for an API resource.
void	setTags(Map<String,String> tags) A TagMap object.
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	setXrayEnabled(Boolean xrayEnabled) A flag indicating whether to use X-Ray tracing for the GraphqlApi.
String	toString() Returns a string representation of this object.
CreateGraphqlApiRequest	withAdditionalAuthenticationProviders(AdditionalAuthenticationProvider... additionalAuthenticationProviders) A list of additional authentication providers for the GraphqlApi API.
CreateGraphqlApiRequest	withAdditionalAuthenticationProviders(Collection<AdditionalAuthenticationProvider> additionalAuthenticationProviders) A list of additional authentication providers for the GraphqlApi API.
CreateGraphqlApiRequest	withApiType(GraphQLApiType apiType) The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).
CreateGraphqlApiRequest	withApiType(String apiType) The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).
CreateGraphqlApiRequest	withAuthenticationType(AuthenticationType authenticationType) The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
CreateGraphqlApiRequest	withAuthenticationType(String authenticationType) The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
CreateGraphqlApiRequest	withLambdaAuthorizerConfig(LambdaAuthorizerConfig lambdaAuthorizerConfig) Configuration for Lambda function authorization.
CreateGraphqlApiRequest	withLogConfig(LogConfig logConfig) The Amazon CloudWatch Logs configuration.
CreateGraphqlApiRequest	withMergedApiExecutionRoleArn(String mergedApiExecutionRoleArn) The Identity and Access Management service role ARN for a merged API.
CreateGraphqlApiRequest	withName(String name) A user-supplied name for the GraphqlApi.
CreateGraphqlApiRequest	withOpenIDConnectConfig(OpenIDConnectConfig openIDConnectConfig) The OIDC configuration.
CreateGraphqlApiRequest	withOwnerContact(String ownerContact) The owner contact information for an API resource.
CreateGraphqlApiRequest	withTags(Map<String,String> tags) A TagMap object.
CreateGraphqlApiRequest	withUserPoolConfig(UserPoolConfig userPoolConfig) The Amazon Cognito user pool configuration.
CreateGraphqlApiRequest	withVisibility(GraphQLApiVisibility visibility) Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE).
CreateGraphqlApiRequest	withVisibility(String visibility) Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE).
CreateGraphqlApiRequest	withXrayEnabled(Boolean xrayEnabled) A flag indicating whether to use X-Ray tracing for the GraphqlApi.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateGraphqlApiRequest

public CreateGraphqlApiRequest()

Method Detail

setName

public void setName(String name)

A user-supplied name for the GraphqlApi.

Parameters:

name - A user-supplied name for the GraphqlApi.

getName

public String getName()

A user-supplied name for the GraphqlApi.

Returns:

A user-supplied name for the GraphqlApi.

withName

public CreateGraphqlApiRequest withName(String name)

A user-supplied name for the GraphqlApi.

Parameters:

name - A user-supplied name for the GraphqlApi.

Returns:

Returns a reference to this object so that method calls can be chained together.

setLogConfig

public void setLogConfig(LogConfig logConfig)

The Amazon CloudWatch Logs configuration.

Parameters:

logConfig - The Amazon CloudWatch Logs configuration.

getLogConfig

public LogConfig getLogConfig()

The Amazon CloudWatch Logs configuration.

Returns:

The Amazon CloudWatch Logs configuration.

withLogConfig

public CreateGraphqlApiRequest withLogConfig(LogConfig logConfig)

The Amazon CloudWatch Logs configuration.

Parameters:

logConfig - The Amazon CloudWatch Logs configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAuthenticationType

public void setAuthenticationType(String authenticationType)

The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

Parameters:

authenticationType - The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

See Also:

AuthenticationType

getAuthenticationType

public String getAuthenticationType()

The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

Returns:

The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

See Also:

AuthenticationType

withAuthenticationType

public CreateGraphqlApiRequest withAuthenticationType(String authenticationType)

The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

Parameters:

authenticationType - The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthenticationType

withAuthenticationType

public CreateGraphqlApiRequest withAuthenticationType(AuthenticationType authenticationType)

The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

Parameters:

authenticationType - The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthenticationType

setUserPoolConfig

public void setUserPoolConfig(UserPoolConfig userPoolConfig)

The Amazon Cognito user pool configuration.

Parameters:

userPoolConfig - The Amazon Cognito user pool configuration.

getUserPoolConfig

public UserPoolConfig getUserPoolConfig()

The Amazon Cognito user pool configuration.

Returns:

The Amazon Cognito user pool configuration.

withUserPoolConfig

public CreateGraphqlApiRequest withUserPoolConfig(UserPoolConfig userPoolConfig)

The Amazon Cognito user pool configuration.

Parameters:

userPoolConfig - The Amazon Cognito user pool configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOpenIDConnectConfig

public void setOpenIDConnectConfig(OpenIDConnectConfig openIDConnectConfig)

The OIDC configuration.

Parameters:

openIDConnectConfig - The OIDC configuration.

getOpenIDConnectConfig

public OpenIDConnectConfig getOpenIDConnectConfig()

The OIDC configuration.

Returns:

The OIDC configuration.

withOpenIDConnectConfig

public CreateGraphqlApiRequest withOpenIDConnectConfig(OpenIDConnectConfig openIDConnectConfig)

The OIDC configuration.

Parameters:

openIDConnectConfig - The OIDC configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public Map<String,String> getTags()

A TagMap object.

Returns:

A TagMap object.

setTags

public void setTags(Map<String,String> tags)

A TagMap object.

Parameters:

tags - A TagMap object.

withTags

public CreateGraphqlApiRequest withTags(Map<String,String> tags)

A TagMap object.

Parameters:

tags - A TagMap object.

Returns:

Returns a reference to this object so that method calls can be chained together.

addTagsEntry

public CreateGraphqlApiRequest addTagsEntry(String key,
                                            String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateGraphqlApiRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

getAdditionalAuthenticationProviders

public List<AdditionalAuthenticationProvider> getAdditionalAuthenticationProviders()

A list of additional authentication providers for the GraphqlApi API.

Returns:

A list of additional authentication providers for the GraphqlApi API.

setAdditionalAuthenticationProviders

public void setAdditionalAuthenticationProviders(Collection<AdditionalAuthenticationProvider> additionalAuthenticationProviders)

A list of additional authentication providers for the GraphqlApi API.

Parameters:

additionalAuthenticationProviders - A list of additional authentication providers for the GraphqlApi API.

withAdditionalAuthenticationProviders

public CreateGraphqlApiRequest 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.

Parameters:

additionalAuthenticationProviders - A list of additional authentication providers for the GraphqlApi API.

Returns:

Returns a reference to this object so that method calls can be chained together.

withAdditionalAuthenticationProviders

public CreateGraphqlApiRequest withAdditionalAuthenticationProviders(Collection<AdditionalAuthenticationProvider> additionalAuthenticationProviders)

A list of additional authentication providers for the GraphqlApi API.

Parameters:

additionalAuthenticationProviders - A list of additional authentication providers for the GraphqlApi API.

Returns:

Returns a reference to this object so that method calls can be chained together.

setXrayEnabled

public void setXrayEnabled(Boolean xrayEnabled)

A flag indicating whether to use X-Ray tracing for the GraphqlApi.

Parameters:

xrayEnabled - A flag indicating whether to use X-Ray tracing for the GraphqlApi.

getXrayEnabled

public Boolean getXrayEnabled()

A flag indicating whether to use X-Ray tracing for the GraphqlApi.

Returns:

A flag indicating whether to use X-Ray tracing for the GraphqlApi.

withXrayEnabled

public CreateGraphqlApiRequest withXrayEnabled(Boolean xrayEnabled)

A flag indicating whether to use X-Ray tracing for the GraphqlApi.

Parameters:

xrayEnabled - A flag indicating whether to use X-Ray tracing for the GraphqlApi.

Returns:

Returns a reference to this object so that method calls can be chained together.

isXrayEnabled

public Boolean isXrayEnabled()

A flag indicating whether to use X-Ray tracing for the GraphqlApi.

Returns:

A flag indicating whether to use X-Ray tracing for the GraphqlApi.

setLambdaAuthorizerConfig

public void setLambdaAuthorizerConfig(LambdaAuthorizerConfig lambdaAuthorizerConfig)

Configuration for Lambda function authorization.

Parameters:

lambdaAuthorizerConfig - Configuration for Lambda function authorization.

getLambdaAuthorizerConfig

public LambdaAuthorizerConfig getLambdaAuthorizerConfig()

Configuration for Lambda function authorization.

Returns:

Configuration for Lambda function authorization.

withLambdaAuthorizerConfig

public CreateGraphqlApiRequest withLambdaAuthorizerConfig(LambdaAuthorizerConfig lambdaAuthorizerConfig)

Configuration for Lambda function authorization.

Parameters:

lambdaAuthorizerConfig - Configuration for Lambda function authorization.

Returns:

Returns a reference to this object so that method calls can be chained together.

setVisibility

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.

Parameters:

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.

See Also:

GraphQLApiVisibility

getVisibility

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.

Returns:

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.

See Also:

GraphQLApiVisibility

withVisibility

public CreateGraphqlApiRequest 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GraphQLApiVisibility

withVisibility

public CreateGraphqlApiRequest 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GraphQLApiVisibility

setApiType

public void setApiType(String apiType)

The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).

Parameters:

apiType - The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).

See Also:

GraphQLApiType

getApiType

public String getApiType()

The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).

Returns:

The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).

See Also:

GraphQLApiType

withApiType

public CreateGraphqlApiRequest withApiType(String apiType)

The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).

Parameters:

apiType - The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GraphQLApiType

withApiType

public CreateGraphqlApiRequest withApiType(GraphQLApiType apiType)

The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).

Parameters:

apiType - The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GraphQLApiType

setMergedApiExecutionRoleArn

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.

Parameters:

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.

getMergedApiExecutionRoleArn

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.

Returns:

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.

withMergedApiExecutionRoleArn

public CreateGraphqlApiRequest 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOwnerContact

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.

Parameters:

ownerContact - The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

getOwnerContact

public String getOwnerContact()

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

Returns:

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

withOwnerContact

public CreateGraphqlApiRequest withOwnerContact(String ownerContact)

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

Parameters:

ownerContact - The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateGraphqlApiRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()