Class CfnGraphQLApiProps.Jsii$Proxy
- All Implemented Interfaces:
CfnGraphQLApiProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnGraphQLApiProps
CfnGraphQLApiProps
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.appsync.CfnGraphQLApiProps
CfnGraphQLApiProps.Builder, CfnGraphQLApiProps.Jsii$Proxy
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Jsii$Proxy
(CfnGraphQLApiProps.Builder builder) Constructor that initializes the object based on literal property values passed by theCfnGraphQLApiProps.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final Object
A list of additional authentication providers for theGraphqlApi
API.final String
The value that indicates whether the GraphQL API is a standard API (GRAPHQL
) or merged API (MERGED
).final String
Security configuration for your GraphQL API.final Object
Enables and controls the enhanced metrics feature.final Object
A map containing the list of resources with their properties and environment variables.final String
Sets the value of the GraphQL API to enable (ENABLED
) or disable (DISABLED
) introspection.final Object
ALambdaAuthorizerConfig
holds configuration on how to authorize AWS AppSync API access when using theAWS_LAMBDA
authorizer mode.final Object
The Amazon CloudWatch Logs configuration.final String
The AWS Identity and Access Management service role ARN for a merged API.final String
getName()
The API name.final Object
The OpenID Connect configuration.final String
The owner contact information for an API resource.final Number
The maximum depth a query can have in a single request.final Number
The maximum number of resolvers that can be invoked in a single request.getTags()
An arbitrary set of tags (key-value pairs) for this GraphQL API.final Object
Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.final String
Sets the scope of the GraphQL API to public (GLOBAL
) or private (PRIVATE
).final Object
A flag indicating whether to use AWS X-Ray tracing for thisGraphqlApi
.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef
- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theCfnGraphQLApiProps.Builder
.
-
-
Method Details
-
getAuthenticationType
Description copied from interface:CfnGraphQLApiProps
Security configuration for your GraphQL API.For allowed values (such as
API_KEY
,AWS_IAM
,AMAZON_COGNITO_USER_POOLS
,OPENID_CONNECT
, orAWS_LAMBDA
), see Security in the AWS AppSync Developer Guide .- Specified by:
getAuthenticationType
in interfaceCfnGraphQLApiProps
- See Also:
-
getName
Description copied from interface:CfnGraphQLApiProps
The API name.- Specified by:
getName
in interfaceCfnGraphQLApiProps
- See Also:
-
getAdditionalAuthenticationProviders
Description copied from interface:CfnGraphQLApiProps
A list of additional authentication providers for theGraphqlApi
API.- Specified by:
getAdditionalAuthenticationProviders
in interfaceCfnGraphQLApiProps
- See Also:
-
getApiType
Description copied from interface:CfnGraphQLApiProps
The value that indicates whether the GraphQL API is a standard API (GRAPHQL
) or merged API (MERGED
).WARNING : If the
ApiType
has not been defined, explicitly setting it toGRAPHQL
in a template/stack update will result in an API replacement and new DNS values.The following values are valid:
GRAPHQL | MERGED
- Specified by:
getApiType
in interfaceCfnGraphQLApiProps
- See Also:
-
getEnhancedMetricsConfig
Description copied from interface:CfnGraphQLApiProps
Enables and controls the enhanced metrics feature.Enhanced metrics emit granular data on API usage and performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can configure the types of data that will be sent.
Enhanced metrics can be configured at the resolver, data source, and operation levels. For more information, see Monitoring and logging in the AWS AppSync User Guide .
- Specified by:
getEnhancedMetricsConfig
in interfaceCfnGraphQLApiProps
- See Also:
-
getEnvironmentVariables
Description copied from interface:CfnGraphQLApiProps
A map containing the list of resources with their properties and environment variables.For more information, see Environmental variables .
Pattern :
^[A-Za-z]+\\w*$\\
Minimum : 2
Maximum : 64
- Specified by:
getEnvironmentVariables
in interfaceCfnGraphQLApiProps
- See Also:
-
getIntrospectionConfig
Description copied from interface:CfnGraphQLApiProps
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 .
- Specified by:
getIntrospectionConfig
in interfaceCfnGraphQLApiProps
- See Also:
-
getLambdaAuthorizerConfig
Description copied from interface:CfnGraphQLApiProps
ALambdaAuthorizerConfig
holds configuration on how to authorize AWS AppSync API access when using theAWS_LAMBDA
authorizer mode.Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.
- Specified by:
getLambdaAuthorizerConfig
in interfaceCfnGraphQLApiProps
- See Also:
-
getLogConfig
Description copied from interface:CfnGraphQLApiProps
The Amazon CloudWatch Logs configuration.- Specified by:
getLogConfig
in interfaceCfnGraphQLApiProps
- See Also:
-
getMergedApiExecutionRoleArn
Description copied from interface:CfnGraphQLApiProps
The AWS 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.- Specified by:
getMergedApiExecutionRoleArn
in interfaceCfnGraphQLApiProps
- See Also:
-
getOpenIdConnectConfig
Description copied from interface:CfnGraphQLApiProps
The OpenID Connect configuration.- Specified by:
getOpenIdConnectConfig
in interfaceCfnGraphQLApiProps
- See Also:
-
getOwnerContact
Description copied from interface:CfnGraphQLApiProps
The owner contact information for an API resource.This field accepts any string input with a length of 0 - 256 characters.
- Specified by:
getOwnerContact
in interfaceCfnGraphQLApiProps
- See Also:
-
getQueryDepthLimit
Description copied from interface:CfnGraphQLApiProps
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 between1
and75
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.- Specified by:
getQueryDepthLimit
in interfaceCfnGraphQLApiProps
- See Also:
-
getResolverCountLimit
Description copied from interface:CfnGraphQLApiProps
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 to10000
. When specified, the limit value can be between1
and10000
. This field will produce a limit error if the operation falls out of bounds.- Specified by:
getResolverCountLimit
in interfaceCfnGraphQLApiProps
- See Also:
-
getTags
Description copied from interface:CfnGraphQLApiProps
An arbitrary set of tags (key-value pairs) for this GraphQL API.- Specified by:
getTags
in interfaceCfnGraphQLApiProps
- See Also:
-
getUserPoolConfig
Description copied from interface:CfnGraphQLApiProps
Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.- Specified by:
getUserPoolConfig
in interfaceCfnGraphQLApiProps
- See Also:
-
getVisibility
Description copied from interface:CfnGraphQLApiProps
Sets the scope of the GraphQL API to public (GLOBAL
) or private (PRIVATE
).By default, the scope is set to
Global
if no value is provided.WARNING : If
Visibility
has not been defined, explicitly setting it toGLOBAL
in a template/stack update will result in an API replacement and new DNS values.- Specified by:
getVisibility
in interfaceCfnGraphQLApiProps
- See Also:
-
getXrayEnabled
Description copied from interface:CfnGraphQLApiProps
A flag indicating whether to use AWS X-Ray tracing for thisGraphqlApi
.- Specified by:
getXrayEnabled
in interfaceCfnGraphQLApiProps
- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-