Class CfnGraphQLApiPropsMixin.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnGraphQLApiPropsMixin>
- Enclosing class:
CfnGraphQLApiPropsMixin
CfnGraphQLApiPropsMixin.-
Method Summary
Modifier and TypeMethodDescriptionadditionalAuthenticationProviders(List<? extends Object> additionalAuthenticationProviders) A list of additional authentication providers for theGraphqlApiAPI.additionalAuthenticationProviders(IResolvable additionalAuthenticationProviders) A list of additional authentication providers for theGraphqlApiAPI.The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).authenticationType(String authenticationType) Security configuration for your GraphQL API.build()create()create(CfnPropertyMixinOptions options) enhancedMetricsConfig(CfnGraphQLApiPropsMixin.EnhancedMetricsConfigProperty enhancedMetricsConfig) Enables and controls the enhanced metrics feature.enhancedMetricsConfig(IResolvable enhancedMetricsConfig) Enables and controls the enhanced metrics feature.environmentVariables(Map<String, String> environmentVariables) A map containing the list of resources with their properties and environment variables.environmentVariables(IResolvable environmentVariables) A map containing the list of resources with their properties and environment variables.introspectionConfig(String introspectionConfig) Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection.lambdaAuthorizerConfig(CfnGraphQLApiPropsMixin.LambdaAuthorizerConfigProperty lambdaAuthorizerConfig) ALambdaAuthorizerConfigholds configuration on how to authorize AWS AppSync API access when using theAWS_LAMBDAauthorizer mode.lambdaAuthorizerConfig(IResolvable lambdaAuthorizerConfig) ALambdaAuthorizerConfigholds configuration on how to authorize AWS AppSync API access when using theAWS_LAMBDAauthorizer mode.The Amazon CloudWatch Logs configuration.logConfig(IResolvable logConfig) The Amazon CloudWatch Logs configuration.mergedApiExecutionRoleArn(String mergedApiExecutionRoleArn) The AWS Identity and Access Management service role ARN for a merged API.The API name.openIdConnectConfig(CfnGraphQLApiPropsMixin.OpenIDConnectConfigProperty openIdConnectConfig) The OpenID Connect configuration.openIdConnectConfig(IResolvable openIdConnectConfig) The OpenID Connect configuration.ownerContact(String ownerContact) The owner contact information for an API resource.queryDepthLimit(Number queryDepthLimit) The maximum depth a query can have in a single request.resolverCountLimit(Number resolverCountLimit) The maximum number of resolvers that can be invoked in a single request.An arbitrary set of tags (key-value pairs) for this GraphQL API.userPoolConfig(CfnGraphQLApiPropsMixin.UserPoolConfigProperty userPoolConfig) Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.userPoolConfig(IResolvable userPoolConfig) Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.visibility(String visibility) Sets the scope of the GraphQL API to public (GLOBAL) or private (PRIVATE).xrayEnabled(Boolean xrayEnabled) A flag indicating whether to use AWS X-Ray tracing for thisGraphqlApi.xrayEnabled(IResolvable xrayEnabled) A flag indicating whether to use AWS X-Ray tracing for thisGraphqlApi.
-
Method Details
-
create
@Stability(Stable) public static CfnGraphQLApiPropsMixin.Builder create(CfnPropertyMixinOptions options) - Parameters:
options- Mixin options.- Returns:
- a new instance of
CfnGraphQLApiPropsMixin.Builder.
-
create
- Returns:
- a new instance of
CfnGraphQLApiPropsMixin.Builder.
-
additionalAuthenticationProviders
@Stability(Stable) public CfnGraphQLApiPropsMixin.Builder additionalAuthenticationProviders(IResolvable additionalAuthenticationProviders) A list of additional authentication providers for theGraphqlApiAPI.- Parameters:
additionalAuthenticationProviders- A list of additional authentication providers for theGraphqlApiAPI. This parameter is required.- Returns:
this- See Also:
-
additionalAuthenticationProviders
@Stability(Stable) public CfnGraphQLApiPropsMixin.Builder additionalAuthenticationProviders(List<? extends Object> additionalAuthenticationProviders) A list of additional authentication providers for theGraphqlApiAPI.- Parameters:
additionalAuthenticationProviders- A list of additional authentication providers for theGraphqlApiAPI. This parameter is required.- Returns:
this- See Also:
-
apiType
The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).WARNING : If the
ApiTypehas not been defined, explicitly setting it toGRAPHQLin a template/stack update will result in an API replacement and new DNS values.The following values are valid:
GRAPHQL | MERGED- Parameters:
apiType- The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED). This parameter is required.- Returns:
this- See Also:
-
authenticationType
@Stability(Stable) public CfnGraphQLApiPropsMixin.Builder authenticationType(String authenticationType) 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 .- Parameters:
authenticationType- Security configuration for your GraphQL API. This parameter is required.- Returns:
this- See Also:
-
enhancedMetricsConfig
@Stability(Stable) public CfnGraphQLApiPropsMixin.Builder enhancedMetricsConfig(IResolvable enhancedMetricsConfig) 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 .
- Parameters:
enhancedMetricsConfig- Enables and controls the enhanced metrics feature. This parameter is required.- Returns:
this- See Also:
-
enhancedMetricsConfig
@Stability(Stable) public CfnGraphQLApiPropsMixin.Builder enhancedMetricsConfig(CfnGraphQLApiPropsMixin.EnhancedMetricsConfigProperty enhancedMetricsConfig) 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 .
- Parameters:
enhancedMetricsConfig- Enables and controls the enhanced metrics feature. This parameter is required.- Returns:
this- See Also:
-
environmentVariables
@Stability(Stable) public CfnGraphQLApiPropsMixin.Builder environmentVariables(Map<String, String> environmentVariables) 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
- Parameters:
environmentVariables- A map containing the list of resources with their properties and environment variables. This parameter is required.- Returns:
this- See Also:
-
environmentVariables
@Stability(Stable) public CfnGraphQLApiPropsMixin.Builder environmentVariables(IResolvable environmentVariables) 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
- Parameters:
environmentVariables- A map containing the list of resources with their properties and environment variables. This parameter is required.- Returns:
this- See Also:
-
introspectionConfig
@Stability(Stable) public CfnGraphQLApiPropsMixin.Builder introspectionConfig(String 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
ENABLEDby 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 .
- Parameters:
introspectionConfig- Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. This parameter is required.- Returns:
this- See Also:
-
lambdaAuthorizerConfig
@Stability(Stable) public CfnGraphQLApiPropsMixin.Builder lambdaAuthorizerConfig(IResolvable lambdaAuthorizerConfig) ALambdaAuthorizerConfigholds configuration on how to authorize AWS AppSync API access when using theAWS_LAMBDAauthorizer mode.Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.
- Parameters:
lambdaAuthorizerConfig- ALambdaAuthorizerConfigholds configuration on how to authorize AWS AppSync API access when using theAWS_LAMBDAauthorizer mode. This parameter is required.- Returns:
this- See Also:
-
lambdaAuthorizerConfig
@Stability(Stable) public CfnGraphQLApiPropsMixin.Builder lambdaAuthorizerConfig(CfnGraphQLApiPropsMixin.LambdaAuthorizerConfigProperty lambdaAuthorizerConfig) ALambdaAuthorizerConfigholds configuration on how to authorize AWS AppSync API access when using theAWS_LAMBDAauthorizer mode.Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.
- Parameters:
lambdaAuthorizerConfig- ALambdaAuthorizerConfigholds configuration on how to authorize AWS AppSync API access when using theAWS_LAMBDAauthorizer mode. This parameter is required.- Returns:
this- See Also:
-
logConfig
The Amazon CloudWatch Logs configuration.- Parameters:
logConfig- The Amazon CloudWatch Logs configuration. This parameter is required.- Returns:
this- See Also:
-
logConfig
@Stability(Stable) public CfnGraphQLApiPropsMixin.Builder logConfig(CfnGraphQLApiPropsMixin.LogConfigProperty logConfig) The Amazon CloudWatch Logs configuration.- Parameters:
logConfig- The Amazon CloudWatch Logs configuration. This parameter is required.- Returns:
this- See Also:
-
mergedApiExecutionRoleArn
@Stability(Stable) public CfnGraphQLApiPropsMixin.Builder mergedApiExecutionRoleArn(String mergedApiExecutionRoleArn) 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_MERGEto update the merged API endpoint with the source API changes automatically.- Parameters:
mergedApiExecutionRoleArn- The AWS Identity and Access Management service role ARN for a merged API. This parameter is required.- Returns:
this- See Also:
-
name
The API name.- Parameters:
name- The API name. This parameter is required.- Returns:
this- See Also:
-
openIdConnectConfig
@Stability(Stable) public CfnGraphQLApiPropsMixin.Builder openIdConnectConfig(IResolvable openIdConnectConfig) The OpenID Connect configuration.- Parameters:
openIdConnectConfig- The OpenID Connect configuration. This parameter is required.- Returns:
this- See Also:
-
openIdConnectConfig
@Stability(Stable) public CfnGraphQLApiPropsMixin.Builder openIdConnectConfig(CfnGraphQLApiPropsMixin.OpenIDConnectConfigProperty openIdConnectConfig) The OpenID Connect configuration.- Parameters:
openIdConnectConfig- The OpenID Connect configuration. This parameter is required.- Returns:
this- See Also:
-
ownerContact
The owner contact information for an API resource.This field accepts any string input with a length of 0 - 256 characters.
- Parameters:
ownerContact- The owner contact information for an API resource. This parameter is required.- Returns:
this- See Also:
-
queryDepthLimit
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 between1and75nested 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.- Parameters:
queryDepthLimit- The maximum depth a query can have in a single request. This parameter is required.- Returns:
this- See Also:
-
resolverCountLimit
@Stability(Stable) public CfnGraphQLApiPropsMixin.Builder resolverCountLimit(Number resolverCountLimit) 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 between1and10000. This field will produce a limit error if the operation falls out of bounds.- Parameters:
resolverCountLimit- The maximum number of resolvers that can be invoked in a single request. This parameter is required.- Returns:
this- See Also:
-
tags
An arbitrary set of tags (key-value pairs) for this GraphQL API.- Parameters:
tags- An arbitrary set of tags (key-value pairs) for this GraphQL API. This parameter is required.- Returns:
this- See Also:
-
userPoolConfig
@Stability(Stable) public CfnGraphQLApiPropsMixin.Builder userPoolConfig(IResolvable userPoolConfig) Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.- Parameters:
userPoolConfig- Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint. This parameter is required.- Returns:
this- See Also:
-
userPoolConfig
@Stability(Stable) public CfnGraphQLApiPropsMixin.Builder userPoolConfig(CfnGraphQLApiPropsMixin.UserPoolConfigProperty userPoolConfig) Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.- Parameters:
userPoolConfig- Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint. This parameter is required.- Returns:
this- See Also:
-
visibility
Sets the scope of the GraphQL API to public (GLOBAL) or private (PRIVATE).By default, the scope is set to
Globalif no value is provided.WARNING : If
Visibilityhas not been defined, explicitly setting it toGLOBALin a template/stack update will result in an API replacement and new DNS values.- Parameters:
visibility- Sets the scope of the GraphQL API to public (GLOBAL) or private (PRIVATE). This parameter is required.- Returns:
this- See Also:
-
xrayEnabled
A flag indicating whether to use AWS X-Ray tracing for thisGraphqlApi.- Parameters:
xrayEnabled- A flag indicating whether to use AWS X-Ray tracing for thisGraphqlApi. This parameter is required.- Returns:
this- See Also:
-
xrayEnabled
A flag indicating whether to use AWS X-Ray tracing for thisGraphqlApi.- Parameters:
xrayEnabled- A flag indicating whether to use AWS X-Ray tracing for thisGraphqlApi. This parameter is required.- Returns:
this- See Also:
-
build
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnGraphQLApiPropsMixin>- Returns:
- a newly built instance of
CfnGraphQLApiPropsMixin.
-