Package software.amazon.awssdk.services.appsync.model

Interface GraphqlApi.Builder

    • Method Detail

      • name

        GraphqlApi.Builder name​(String name)

        The API name.

        Parameters:
        name - The API name.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • apiId

        GraphqlApi.Builder apiId​(String apiId)

        The API ID.

        Parameters:
        apiId - The API ID.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • authenticationType

        GraphqlApi.Builder authenticationType​(String authenticationType)

        The authentication type.

        Parameters:
        authenticationType - The authentication type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AuthenticationType, AuthenticationType

      • logConfig

        GraphqlApi.Builder logConfig​(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.

      • userPoolConfig

        GraphqlApi.Builder userPoolConfig​(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.

      • openIDConnectConfig

        GraphqlApi.Builder openIDConnectConfig​(OpenIDConnectConfig openIDConnectConfig)

        The OpenID Connect configuration.

        Parameters:
        openIDConnectConfig - The OpenID Connect configuration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • arn

        GraphqlApi.Builder arn​(String arn)

        The Amazon Resource Name (ARN).

        Parameters:
        arn - The Amazon Resource Name (ARN).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • uris

        GraphqlApi.Builder uris​(Map<String,​String> uris)

        The URIs.

        Parameters:
        uris - The URIs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        GraphqlApi.Builder tags​(Map<String,​String> tags)

        The tags.

        Parameters:
        tags - The tags.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • additionalAuthenticationProviders

        GraphqlApi.Builder additionalAuthenticationProviders​(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.

      • additionalAuthenticationProviders

        GraphqlApi.Builder additionalAuthenticationProviders​(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.

      • xrayEnabled

        GraphqlApi.Builder xrayEnabled​(Boolean xrayEnabled)

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

        Parameters:
        xrayEnabled - A flag indicating whether to use X-Ray tracing for this GraphqlApi.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • wafWebAclArn

        GraphqlApi.Builder wafWebAclArn​(String wafWebAclArn)

        The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.

        Parameters:
        wafWebAclArn - The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lambdaAuthorizerConfig

        GraphqlApi.Builder lambdaAuthorizerConfig​(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.

      • dns

        GraphqlApi.Builder dns​(Map<String,​String> dns)

        The DNS records for the API.

        Parameters:
        dns - The DNS records for the API.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • visibility

        GraphqlApi.Builder visibility​(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, GraphQLApiVisibility

      • visibility

        GraphqlApi.Builder visibility​(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, GraphQLApiVisibility

      • apiType

        GraphqlApi.Builder apiType​(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, GraphQLApiType

      • apiType

        GraphqlApi.Builder apiType​(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, GraphQLApiType

      • mergedApiExecutionRoleArn

        GraphqlApi.Builder mergedApiExecutionRoleArn​(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.

      • owner

        GraphqlApi.Builder owner​(String owner)

        The account owner of the GraphQL API.

        Parameters:
        owner - The account owner of the GraphQL API.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ownerContact

        GraphqlApi.Builder ownerContact​(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.

      • introspectionConfig

        GraphqlApi.Builder introspectionConfig​(String introspectionConfig)

        Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.

        For more information about introspection, see GraphQL introspection.

        Parameters:
        introspectionConfig - Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.

        For more information about introspection, see GraphQL introspection.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        GraphQLApiIntrospectionConfig, GraphQLApiIntrospectionConfig

      • introspectionConfig

        GraphqlApi.Builder introspectionConfig​(GraphQLApiIntrospectionConfig introspectionConfig)

        Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.

        For more information about introspection, see GraphQL introspection.

        Parameters:
        introspectionConfig - Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.

        For more information about introspection, see GraphQL introspection.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        GraphQLApiIntrospectionConfig, GraphQLApiIntrospectionConfig

      • queryDepthLimit

        GraphqlApi.Builder queryDepthLimit​(Integer queryDepthLimit)

        The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between 1 and 75 nested levels. This field will produce a limit error if the operation falls out of bounds.

        Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.

        Parameters:
        queryDepthLimit - The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between 1 and 75 nested levels. This field will produce a limit error if the operation falls out of bounds.

        Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.

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

      • resolverCountLimit

        GraphqlApi.Builder resolverCountLimit​(Integer resolverCountLimit)

        The maximum number of resolvers that can be invoked in a single request. The default value is 0 (or unspecified), which will set the limit to 10000. When specified, the limit value can be between 1 and 10000. This field will produce a limit error if the operation falls out of bounds.

        Parameters:
        resolverCountLimit - The maximum number of resolvers that can be invoked in a single request. The default value is 0 (or unspecified), which will set the limit to 10000. When specified, the limit value can be between 1 and 10000. This field will produce a limit error if the operation falls out of bounds.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enhancedMetricsConfig

        GraphqlApi.Builder enhancedMetricsConfig​(EnhancedMetricsConfig enhancedMetricsConfig)

        The enhancedMetricsConfig object.

        Parameters:
        enhancedMetricsConfig - The enhancedMetricsConfig object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.