Struct aws_sdk_appsync::operation::create_graphql_api::CreateGraphqlApiInput

#[non_exhaustive]
pub struct CreateGraphqlApiInput {

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

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>

A user-supplied name for the GraphqlApi.

log_config: Option<LogConfig>

The Amazon CloudWatch Logs configuration.

authentication_type: Option<AuthenticationType>

The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

user_pool_config: Option<UserPoolConfig>

The Amazon Cognito user pool configuration.

open_id_connect_config: Option<OpenIdConnectConfig>

The OIDC configuration.

tags: Option<HashMap<String, String>>

A TagMap object.

additional_authentication_providers: Option<Vec<AdditionalAuthenticationProvider>>

A list of additional authentication providers for the GraphqlApi API.

xray_enabled: Option<bool>

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

lambda_authorizer_config: Option<LambdaAuthorizerConfig>

Configuration for Lambda function authorization.

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_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: Option<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: Option<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.

Implementations

impl CreateGraphqlApiInput

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

A user-supplied name for the GraphqlApi.

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

The Amazon CloudWatch Logs configuration.

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

The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

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

The Amazon Cognito user pool configuration.

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

The OIDC configuration.

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

A TagMap object.

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) -> Option<bool>

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

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

Configuration for Lambda function authorization.

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_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) -> Option<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) -> Option<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.

impl CreateGraphqlApiInput

pub fn builder() -> CreateGraphqlApiInputBuilder

Creates a new builder-style object to manufacture CreateGraphqlApiInput.

Trait Implementations

impl Clone for CreateGraphqlApiInput

fn clone(&self) -> CreateGraphqlApiInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateGraphqlApiInput

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

Formats the value using the given formatter.

impl PartialEq for CreateGraphqlApiInput

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for CreateGraphqlApiInput