Package software.amazon.awscdk.services.appsync

Class CfnGraphQLApi.Builder

java.lang.Object
software.amazon.awscdk.services.appsync.CfnGraphQLApi.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnGraphQLApi>
Enclosing class:
CfnGraphQLApi
@Stability(Stable) public static final class CfnGraphQLApi.Builder extends Object implements software.amazon.jsii.Builder<CfnGraphQLApi>
A fluent builder for CfnGraphQLApi.

  • Method Details

    • create

      @Stability(Stable) public static CfnGraphQLApi.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnGraphQLApi.Builder.

    • authenticationType

      @Stability(Stable) public CfnGraphQLApi.Builder authenticationType(String authenticationType)
      Security configuration for your GraphQL API.

      For allowed values (such as API_KEY , AWS_IAM , AMAZON_COGNITO_USER_POOLS , OPENID_CONNECT , or AWS_LAMBDA ), see Security in the AWS AppSync Developer Guide .

      Parameters:
      authenticationType - Security configuration for your GraphQL API. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public CfnGraphQLApi.Builder name(String name)
      The API name.

      Parameters:
      name - The API name. This parameter is required.
      Returns:
      this

    • additionalAuthenticationProviders

      @Stability(Stable) public CfnGraphQLApi.Builder additionalAuthenticationProviders(IResolvable additionalAuthenticationProviders)
      A list of additional authentication providers for the GraphqlApi API.

      Parameters:
      additionalAuthenticationProviders - A list of additional authentication providers for the GraphqlApi API. This parameter is required.
      Returns:
      this

    • additionalAuthenticationProviders

      @Stability(Stable) public CfnGraphQLApi.Builder additionalAuthenticationProviders(List<? extends Object> additionalAuthenticationProviders)
      A list of additional authentication providers for the GraphqlApi API.

      Parameters:
      additionalAuthenticationProviders - A list of additional authentication providers for the GraphqlApi API. This parameter is required.
      Returns:
      this

    • apiType

      @Stability(Stable) public CfnGraphQLApi.Builder apiType(String apiType)
      The value that indicates whether the GraphQL API is a standard API ( GRAPHQL ) or merged API ( MERGED ).

      The following values are valid:

      GRAPHQL | MERGED

      Parameters:
      apiType - The value that indicates whether the GraphQL API is a standard API ( GRAPHQL ) or merged API ( MERGED ). This parameter is required.
      Returns:
      this

    • lambdaAuthorizerConfig

      @Stability(Stable) public CfnGraphQLApi.Builder lambdaAuthorizerConfig(IResolvable lambdaAuthorizerConfig)
      A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.

      Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.

      Parameters:
      lambdaAuthorizerConfig - A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode. This parameter is required.
      Returns:
      this

    • lambdaAuthorizerConfig

      @Stability(Stable) public CfnGraphQLApi.Builder lambdaAuthorizerConfig(CfnGraphQLApi.LambdaAuthorizerConfigProperty lambdaAuthorizerConfig)
      A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.

      Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.

      Parameters:
      lambdaAuthorizerConfig - A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode. This parameter is required.
      Returns:
      this

    • logConfig

      @Stability(Stable) public CfnGraphQLApi.Builder logConfig(IResolvable logConfig)
      The Amazon CloudWatch Logs configuration.

      Parameters:
      logConfig - The Amazon CloudWatch Logs configuration. This parameter is required.
      Returns:
      this

    • logConfig

      @Stability(Stable) public CfnGraphQLApi.Builder logConfig(CfnGraphQLApi.LogConfigProperty logConfig)
      The Amazon CloudWatch Logs configuration.

      Parameters:
      logConfig - The Amazon CloudWatch Logs configuration. This parameter is required.
      Returns:
      this

    • mergedApiExecutionRoleArn

      @Stability(Stable) public CfnGraphQLApi.Builder mergedApiExecutionRoleArn(String mergedApiExecutionRoleArn)
      The AWS 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 AWS Identity and Access Management service role ARN for a merged API. This parameter is required.
      Returns:
      this

    • openIdConnectConfig

      @Stability(Stable) public CfnGraphQLApi.Builder openIdConnectConfig(IResolvable openIdConnectConfig)
      The OpenID Connect configuration.

      Parameters:
      openIdConnectConfig - The OpenID Connect configuration. This parameter is required.
      Returns:
      this

    • openIdConnectConfig

      @Stability(Stable) public CfnGraphQLApi.Builder openIdConnectConfig(CfnGraphQLApi.OpenIDConnectConfigProperty openIdConnectConfig)
      The OpenID Connect configuration.

      Parameters:
      openIdConnectConfig - The OpenID Connect configuration. This parameter is required.
      Returns:
      this

    • ownerContact

      @Stability(Stable) public CfnGraphQLApi.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 parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnGraphQLApi.Builder tags(List<? extends CfnTag> tags)
      An arbitrary set of tags (key-value pairs) for this GraphQL API.

      Parameters:
      tags - An arbitrary set of tags (key-value pairs) for this GraphQL API. This parameter is required.
      Returns:
      this

    • userPoolConfig

      @Stability(Stable) public CfnGraphQLApi.Builder userPoolConfig(IResolvable userPoolConfig)
      Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.

      Parameters:
      userPoolConfig - Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint. This parameter is required.
      Returns:
      this

    • userPoolConfig

      @Stability(Stable) public CfnGraphQLApi.Builder userPoolConfig(CfnGraphQLApi.UserPoolConfigProperty userPoolConfig)
      Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.

      Parameters:
      userPoolConfig - Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint. This parameter is required.
      Returns:
      this

    • visibility

      @Stability(Stable) public CfnGraphQLApi.Builder visibility(String visibility)
      Sets the scope of the GraphQL API to public ( GLOBAL ) or private ( PRIVATE ).

      By default, the scope is set to Global if no value is provided.

      Parameters:
      visibility - Sets the scope of the GraphQL API to public ( GLOBAL ) or private ( PRIVATE ). This parameter is required.
      Returns:
      this

    • xrayEnabled

      @Stability(Stable) public CfnGraphQLApi.Builder xrayEnabled(Boolean xrayEnabled)
      A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi .

      Parameters:
      xrayEnabled - A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi . This parameter is required.
      Returns:
      this

    • xrayEnabled

      @Stability(Stable) public CfnGraphQLApi.Builder xrayEnabled(IResolvable xrayEnabled)
      A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi .

      Parameters:
      xrayEnabled - A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi . This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnGraphQLApi build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnGraphQLApi>
      Returns:
      a newly built instance of CfnGraphQLApi.