Struct GraphqlApi

#[non_exhaustive]
pub struct GraphqlApi {

    pub name: Option<String>,
    pub api_id: Option<String>,
    pub authentication_type: Option<AuthenticationType>,
    pub log_config: Option<LogConfig>,
    pub user_pool_config: Option<UserPoolConfig>,
    pub open_id_connect_config: Option<OpenIdConnectConfig>,
    pub arn: Option<String>,
    pub uris: Option<HashMap<String, String>>,
    pub tags: Option<HashMap<String, String>>,
    pub additional_authentication_providers: Option<Vec<AdditionalAuthenticationProvider>>,
    pub xray_enabled: bool,
    pub waf_web_acl_arn: Option<String>,
    pub lambda_authorizer_config: Option<LambdaAuthorizerConfig>,
    pub dns: Option<HashMap<String, String>>,
    pub visibility: Option<GraphQlApiVisibility>,
    pub api_type: Option<GraphQlApiType>,
    pub merged_api_execution_role_arn: Option<String>,
    pub owner: Option<String>,
    pub owner_contact: Option<String>,
    pub introspection_config: Option<GraphQlApiIntrospectionConfig>,
    pub query_depth_limit: i32,
    pub resolver_count_limit: i32,
    pub enhanced_metrics_config: Option<EnhancedMetricsConfig>,
}

Describes a GraphQL API.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The API name.

api_id: Option<String>

The API ID.

authentication_type: Option<AuthenticationType>

The authentication type.

log_config: Option<LogConfig>

The Amazon CloudWatch Logs configuration.

user_pool_config: Option<UserPoolConfig>

The Amazon Cognito user pool configuration.

open_id_connect_config: Option<OpenIdConnectConfig>

The OpenID Connect configuration.

arn: Option<String>

The Amazon Resource Name (ARN).

uris: Option<HashMap<String, String>>

The URIs.

tags: Option<HashMap<String, String>>

The tags.

additional_authentication_providers: Option<Vec<AdditionalAuthenticationProvider>>

A list of additional authentication providers for the GraphqlApi API.

xray_enabled: bool

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

waf_web_acl_arn: Option<String>

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

lambda_authorizer_config: Option<LambdaAuthorizerConfig>

Configuration for Lambda function authorization.

dns: Option<HashMap<String, String>>

The DNS records for the API.

visibility: Option<GraphQlApiVisibility>

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.

api_type: Option<GraphQlApiType>

The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).

merged_api_execution_role_arn: Option<String>

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.

owner: Option<String>

The account owner of the GraphQL API.

owner_contact: Option<String>

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

introspection_config: Option<GraphQlApiIntrospectionConfig>

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.

query_depth_limit: i32

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.

resolver_count_limit: i32

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.

enhanced_metrics_config: Option<EnhancedMetricsConfig>

The enhancedMetricsConfig object.

Implementations

impl GraphqlApi

pub fn name(&self) -> Option<&str>

The API name.

pub fn api_id(&self) -> Option<&str>

The API ID.

pub fn authentication_type(&self) -> Option<&AuthenticationType>

The authentication type.

pub fn log_config(&self) -> Option<&LogConfig>

The Amazon CloudWatch Logs configuration.

pub fn user_pool_config(&self) -> Option<&UserPoolConfig>

The Amazon Cognito user pool configuration.

pub fn open_id_connect_config(&self) -> Option<&OpenIdConnectConfig>

The OpenID Connect configuration.

pub fn arn(&self) -> Option<&str>

The Amazon Resource Name (ARN).

pub fn uris(&self) -> Option<&HashMap<String, String>>

The URIs.

pub fn tags(&self) -> Option<&HashMap<String, String>>

The tags.

pub fn additional_authentication_providers( &self, ) -> &[AdditionalAuthenticationProvider]

A list of additional authentication providers for the GraphqlApi API.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .additional_authentication_providers.is_none().

pub fn xray_enabled(&self) -> bool

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

pub fn waf_web_acl_arn(&self) -> Option<&str>

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

pub fn lambda_authorizer_config(&self) -> Option<&LambdaAuthorizerConfig>

Configuration for Lambda function authorization.

pub fn dns(&self) -> Option<&HashMap<String, String>>

The DNS records for the API.

pub fn visibility(&self) -> Option<&GraphQlApiVisibility>

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.

pub fn api_type(&self) -> Option<&GraphQlApiType>

The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).

pub fn merged_api_execution_role_arn(&self) -> Option<&str>

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.

pub fn owner(&self) -> Option<&str>

The account owner of the GraphQL API.

pub fn owner_contact(&self) -> Option<&str>

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

pub fn introspection_config(&self) -> Option<&GraphQlApiIntrospectionConfig>

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.

pub fn query_depth_limit(&self) -> i32

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.

pub fn resolver_count_limit(&self) -> i32

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.

pub fn enhanced_metrics_config(&self) -> Option<&EnhancedMetricsConfig>

The enhancedMetricsConfig object.

impl GraphqlApi

pub fn builder() -> GraphqlApiBuilder

Creates a new builder-style object to manufacture GraphqlApi.

Trait Implementations

impl Clone for GraphqlApi

fn clone(&self) -> GraphqlApi

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GraphqlApi

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GraphqlApi

fn eq(&self, other: &GraphqlApi) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GraphqlApi