Package com.pulumi.aws.appsync

Class GraphQLApiArgs

  • public final class GraphQLApiArgs
extends com.pulumi.resources.ResourceArgs

    • Method Detail

      • additionalAuthenticationProviders

        public java.util.Optional<com.pulumi.core.Output<java.util.List<GraphQLApiAdditionalAuthenticationProviderArgs>>> additionalAuthenticationProviders()
        Returns:
        One or more additional authentication providers for the GraphQL API. See `additionalAuthenticationProvider` Block for details.

      • apiType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> apiType()
        Returns:
        API type. Valid values are `GRAPHQL` or `MERGED`. A `MERGED` type requires `mergedApiExecutionRoleArn` to be set.

      • authenticationType

        public com.pulumi.core.Output<java.lang.String> authenticationType()
        Returns:
        Authentication type. Valid values: `API_KEY`, `AWS_IAM`, `AMAZON_COGNITO_USER_POOLS`, `OPENID_CONNECT`, `AWS_LAMBDA`

      • enhancedMetricsConfig

        public java.util.Optional<com.pulumi.core.Output<GraphQLApiEnhancedMetricsConfigArgs>> enhancedMetricsConfig()
        Returns:
        Enables and controls the enhanced metrics feature. See `enhancedMetricsConfig` Block for details.

      • introspectionConfig

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> introspectionConfig()
        Returns:
        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](https://graphql.org/learn/introspection/).

      • lambdaAuthorizerConfig

        public java.util.Optional<com.pulumi.core.Output<GraphQLApiLambdaAuthorizerConfigArgs>> lambdaAuthorizerConfig()
        Returns:
        Nested argument containing Lambda authorizer configuration. See `lambdaAuthorizerConfig` Block for details.

      • logConfig

        public java.util.Optional<com.pulumi.core.Output<GraphQLApiLogConfigArgs>> logConfig()
        Returns:
        Nested argument containing logging configuration. See `logConfig` Block for details.

      • mergedApiExecutionRoleArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> mergedApiExecutionRoleArn()
        Returns:
        ARN of the execution role when `apiType` is set to `MERGED`.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        User-supplied name for the GraphQL API. The following arguments are optional:

      • openidConnectConfig

        public java.util.Optional<com.pulumi.core.Output<GraphQLApiOpenidConnectConfigArgs>> openidConnectConfig()
        Returns:
        Nested argument containing OpenID Connect configuration. See `openidConnectConfig` Block for details.

      • queryDepthLimit

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> queryDepthLimit()
        Returns:
        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.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • resolverCountLimit

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> resolverCountLimit()
        Returns:
        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.

      • schema

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> schema()
        Returns:
        Schema definition, in GraphQL schema language format. This provider cannot perform drift detection of this configuration.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • userPoolConfig

        public java.util.Optional<com.pulumi.core.Output<GraphQLApiUserPoolConfigArgs>> userPoolConfig()
        Returns:
        Amazon Cognito User Pool configuration. See `userPoolConfig` Block for details.

      • visibility

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> visibility()
        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.

      • xrayEnabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> xrayEnabled()
        Returns:
        Whether tracing with X-ray is enabled. Defaults to false.