GraphQLApiState class

Input properties used for looking up and filtering GraphQLApi resources.

Constructors

GraphQLApiState({Input<List<GraphQLApiAdditionalAuthenticationProvider>?>? additionalAuthenticationProviders, Input<String?>? apiType, Input<String?>? arn, Input<String?>? authenticationType, Input<GraphQLApiEnhancedMetricsConfig?>? enhancedMetricsConfig, Input<String?>? introspectionConfig, Input<GraphQLApiLambdaAuthorizerConfig?>? lambdaAuthorizerConfig, Input<GraphQLApiLogConfig?>? logConfig, Input<String?>? mergedApiExecutionRoleArn, Input<String?>? name, Input<GraphQLApiOpenidConnectConfig?>? openidConnectConfig, Input<int?>? queryDepthLimit, Input<String?>? region, Input<int?>? resolverCountLimit, Input<String?>? schema, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<Map<String, String>?>? uris, Input<GraphQLApiUserPoolConfig?>? userPoolConfig, Input<String?>? visibility, Input<bool?>? xrayEnabled})
Creates a new GraphQLApiState. additionalAuthenticationProviders One or more additional authentication providers for the GraphQL API. See additionalAuthenticationProvider Block for details. apiType API type. Valid values are GRAPHQL or MERGED. A MERGED type requires mergedApiExecutionRoleArn to be set. arn ARN authenticationType Authentication type. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA enhancedMetricsConfig Enables and controls the enhanced metrics feature. See enhancedMetricsConfig Block for details. 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. lambdaAuthorizerConfig Nested argument containing Lambda authorizer configuration. See lambdaAuthorizerConfig Block for details. logConfig Nested argument containing logging configuration. See logConfig Block for details. mergedApiExecutionRoleArn ARN of the execution role when apiType is set to MERGED. name User-supplied name for the GraphQL API. openidConnectConfig Nested argument containing OpenID Connect configuration. See openidConnectConfig Block for details. queryDepthLimit 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. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. resolverCountLimit 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 Schema definition, in GraphQL schema language format. This provider cannot perform drift detection of this configuration. tags 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. tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. uris Map of URIs associated with the API E.g., uris["GRAPHQL"] = https://ID.appsync-api.REGION.amazonaws.com/graphql userPoolConfig Amazon Cognito User Pool configuration. See userPoolConfig Block for details. 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. xrayEnabled Whether tracing with X-ray is enabled. Defaults to false.
const
GraphQLApiState.fromMap(Map<String, dynamic> map)
factory

Properties

additionalAuthenticationProviders → Input<List<GraphQLApiAdditionalAuthenticationProvider>?>?
One or more additional authentication providers for the GraphQL API. See additionalAuthenticationProvider Block for details.
final
apiType → Input<String?>?
API type. Valid values are GRAPHQL or MERGED. A MERGED type requires mergedApiExecutionRoleArn to be set.
final
arn → Input<String?>?
ARN
final
authenticationType → Input<String?>?
Authentication type. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA
final
enhancedMetricsConfig → Input<GraphQLApiEnhancedMetricsConfig?>?
Enables and controls the enhanced metrics feature. See enhancedMetricsConfig Block for details.
final
hashCode → int
The hash code for this object.
no setterinherited
introspectionConfig → Input<String?>?
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.
final
lambdaAuthorizerConfig → Input<GraphQLApiLambdaAuthorizerConfig?>?
Nested argument containing Lambda authorizer configuration. See lambdaAuthorizerConfig Block for details.
final
logConfig → Input<GraphQLApiLogConfig?>?
Nested argument containing logging configuration. See logConfig Block for details.
final
mergedApiExecutionRoleArn → Input<String?>?
ARN of the execution role when apiType is set to MERGED.
final
name → Input<String?>?
User-supplied name for the GraphQL API.
final
openidConnectConfig → Input<GraphQLApiOpenidConnectConfig?>?
Nested argument containing OpenID Connect configuration. See openidConnectConfig Block for details.
final
queryDepthLimit → Input<int?>?
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.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
resolverCountLimit → Input<int?>?
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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schema → Input<String?>?
Schema definition, in GraphQL schema language format. This provider cannot perform drift detection of this configuration.
final
tags → Input<Map<String, String>?>?
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.
final
tagsAll → Input<Map<String, String>?>?
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
uris → Input<Map<String, String>?>?
Map of URIs associated with the API E.g., uris["GRAPHQL"] = https://ID.appsync-api.REGION.amazonaws.com/graphql
final
userPoolConfig → Input<GraphQLApiUserPoolConfig?>?
Amazon Cognito User Pool configuration. See userPoolConfig Block for details.
final
visibility → Input<String?>?
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.
final
xrayEnabled → Input<bool?>?
Whether tracing with X-ray is enabled. Defaults to false.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited