Package com.pulumi.aws.appsync

Class GraphQLApi

  • public class GraphQLApi
extends com.pulumi.resources.CustomResource

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Detail

      • GraphQLApi

        public GraphQLApi​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • GraphQLApi

        public GraphQLApi​(java.lang.String name,
                  GraphQLApiArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • GraphQLApi

        public GraphQLApi​(java.lang.String name,
                  GraphQLApiArgs args,
                  @Nullable
                  com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • additionalAuthenticationProviders

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

      • apiType

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

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN

      • 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 com.pulumi.core.Output<java.util.Optional<GraphQLApiEnhancedMetricsConfig>> enhancedMetricsConfig()
        Returns:
        Enables and controls the enhanced metrics feature. See `enhanced_metrics_config` Block for details.

      • introspectionConfig

        public com.pulumi.core.Output<java.util.Optional<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 com.pulumi.core.Output<java.util.Optional<GraphQLApiLambdaAuthorizerConfig>> lambdaAuthorizerConfig()
        Returns:
        Nested argument containing Lambda authorizer configuration. See `lambda_authorizer_config` Block for details.

      • logConfig

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

      • mergedApiExecutionRoleArn

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

      • name

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

      • openidConnectConfig

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

      • queryDepthLimit

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

      • resolverCountLimit

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

      • schema

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

      • tags

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

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.

      • uris

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> uris()
        Returns:
        Map of URIs associated with the API E.g., `uris["GRAPHQL"] = https://ID.appsync-api.REGION.amazonaws.com/graphql`

      • userPoolConfig

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

      • visibility

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

      • get

        public static GraphQLApi get​(java.lang.String name,
                             com.pulumi.core.Output<java.lang.String> id,
                             @Nullable
                             GraphQLApiState state,
                             @Nullable
                             com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.