Class CfnGraphQLApiMixinProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnGraphQLApiMixinProps>
- Enclosing interface:
CfnGraphQLApiMixinProps
CfnGraphQLApiMixinProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionadditionalAuthenticationProviders(List<? extends Object> additionalAuthenticationProviders) Sets the value ofCfnGraphQLApiMixinProps.getAdditionalAuthenticationProviders()additionalAuthenticationProviders(IResolvable additionalAuthenticationProviders) Sets the value ofCfnGraphQLApiMixinProps.getAdditionalAuthenticationProviders()Sets the value ofCfnGraphQLApiMixinProps.getApiType()authenticationType(String authenticationType) Sets the value ofCfnGraphQLApiMixinProps.getAuthenticationType()build()Builds the configured instance.enhancedMetricsConfig(IResolvable enhancedMetricsConfig) Sets the value ofCfnGraphQLApiMixinProps.getEnhancedMetricsConfig()enhancedMetricsConfig(CfnGraphQLApiPropsMixin.EnhancedMetricsConfigProperty enhancedMetricsConfig) Sets the value ofCfnGraphQLApiMixinProps.getEnhancedMetricsConfig()environmentVariables(Map<String, String> environmentVariables) Sets the value ofCfnGraphQLApiMixinProps.getEnvironmentVariables()environmentVariables(IResolvable environmentVariables) Sets the value ofCfnGraphQLApiMixinProps.getEnvironmentVariables()introspectionConfig(String introspectionConfig) Sets the value ofCfnGraphQLApiMixinProps.getIntrospectionConfig()lambdaAuthorizerConfig(IResolvable lambdaAuthorizerConfig) Sets the value ofCfnGraphQLApiMixinProps.getLambdaAuthorizerConfig()lambdaAuthorizerConfig(CfnGraphQLApiPropsMixin.LambdaAuthorizerConfigProperty lambdaAuthorizerConfig) Sets the value ofCfnGraphQLApiMixinProps.getLambdaAuthorizerConfig()logConfig(IResolvable logConfig) Sets the value ofCfnGraphQLApiMixinProps.getLogConfig()Sets the value ofCfnGraphQLApiMixinProps.getLogConfig()mergedApiExecutionRoleArn(String mergedApiExecutionRoleArn) Sets the value ofCfnGraphQLApiMixinProps.getMergedApiExecutionRoleArn()Sets the value ofCfnGraphQLApiMixinProps.getName()openIdConnectConfig(IResolvable openIdConnectConfig) Sets the value ofCfnGraphQLApiMixinProps.getOpenIdConnectConfig()openIdConnectConfig(CfnGraphQLApiPropsMixin.OpenIDConnectConfigProperty openIdConnectConfig) Sets the value ofCfnGraphQLApiMixinProps.getOpenIdConnectConfig()ownerContact(String ownerContact) Sets the value ofCfnGraphQLApiMixinProps.getOwnerContact()queryDepthLimit(Number queryDepthLimit) Sets the value ofCfnGraphQLApiMixinProps.getQueryDepthLimit()resolverCountLimit(Number resolverCountLimit) Sets the value ofCfnGraphQLApiMixinProps.getResolverCountLimit()Sets the value ofCfnGraphQLApiMixinProps.getTags()userPoolConfig(IResolvable userPoolConfig) Sets the value ofCfnGraphQLApiMixinProps.getUserPoolConfig()userPoolConfig(CfnGraphQLApiPropsMixin.UserPoolConfigProperty userPoolConfig) Sets the value ofCfnGraphQLApiMixinProps.getUserPoolConfig()visibility(String visibility) Sets the value ofCfnGraphQLApiMixinProps.getVisibility()xrayEnabled(Boolean xrayEnabled) Sets the value ofCfnGraphQLApiMixinProps.getXrayEnabled()xrayEnabled(IResolvable xrayEnabled) Sets the value ofCfnGraphQLApiMixinProps.getXrayEnabled()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
additionalAuthenticationProviders
@Stability(Stable) public CfnGraphQLApiMixinProps.Builder additionalAuthenticationProviders(IResolvable additionalAuthenticationProviders) Sets the value ofCfnGraphQLApiMixinProps.getAdditionalAuthenticationProviders()- Parameters:
additionalAuthenticationProviders- A list of additional authentication providers for theGraphqlApiAPI.- Returns:
this
-
additionalAuthenticationProviders
@Stability(Stable) public CfnGraphQLApiMixinProps.Builder additionalAuthenticationProviders(List<? extends Object> additionalAuthenticationProviders) Sets the value ofCfnGraphQLApiMixinProps.getAdditionalAuthenticationProviders()- Parameters:
additionalAuthenticationProviders- A list of additional authentication providers for theGraphqlApiAPI.- Returns:
this
-
apiType
Sets the value ofCfnGraphQLApiMixinProps.getApiType()- Parameters:
apiType- The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED). WARNING : If theApiTypehas 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- Returns:
this
-
authenticationType
@Stability(Stable) public CfnGraphQLApiMixinProps.Builder authenticationType(String authenticationType) Sets the value ofCfnGraphQLApiMixinProps.getAuthenticationType()- Parameters:
authenticationType- Security configuration for your GraphQL API. For allowed values (such asAPI_KEY,AWS_IAM,AMAZON_COGNITO_USER_POOLS,OPENID_CONNECT, orAWS_LAMBDA), see Security in the AWS AppSync Developer Guide .- Returns:
this
-
enhancedMetricsConfig
@Stability(Stable) public CfnGraphQLApiMixinProps.Builder enhancedMetricsConfig(IResolvable enhancedMetricsConfig) Sets the value ofCfnGraphQLApiMixinProps.getEnhancedMetricsConfig()- Parameters:
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 .
- Returns:
this
-
enhancedMetricsConfig
@Stability(Stable) public CfnGraphQLApiMixinProps.Builder enhancedMetricsConfig(CfnGraphQLApiPropsMixin.EnhancedMetricsConfigProperty enhancedMetricsConfig) Sets the value ofCfnGraphQLApiMixinProps.getEnhancedMetricsConfig()- Parameters:
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 .
- Returns:
this
-
environmentVariables
@Stability(Stable) public CfnGraphQLApiMixinProps.Builder environmentVariables(Map<String, String> environmentVariables) Sets the value ofCfnGraphQLApiMixinProps.getEnvironmentVariables()- Parameters:
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
- Returns:
this
-
environmentVariables
@Stability(Stable) public CfnGraphQLApiMixinProps.Builder environmentVariables(IResolvable environmentVariables) Sets the value ofCfnGraphQLApiMixinProps.getEnvironmentVariables()- Parameters:
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
- Returns:
this
-
introspectionConfig
@Stability(Stable) public CfnGraphQLApiMixinProps.Builder introspectionConfig(String introspectionConfig) Sets the value ofCfnGraphQLApiMixinProps.getIntrospectionConfig()- Parameters:
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 toENABLEDby 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 .
- Returns:
this
-
lambdaAuthorizerConfig
@Stability(Stable) public CfnGraphQLApiMixinProps.Builder lambdaAuthorizerConfig(IResolvable lambdaAuthorizerConfig) Sets the value ofCfnGraphQLApiMixinProps.getLambdaAuthorizerConfig()- Parameters:
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.- Returns:
this
-
lambdaAuthorizerConfig
@Stability(Stable) public CfnGraphQLApiMixinProps.Builder lambdaAuthorizerConfig(CfnGraphQLApiPropsMixin.LambdaAuthorizerConfigProperty lambdaAuthorizerConfig) Sets the value ofCfnGraphQLApiMixinProps.getLambdaAuthorizerConfig()- Parameters:
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.- Returns:
this
-
logConfig
Sets the value ofCfnGraphQLApiMixinProps.getLogConfig()- Parameters:
logConfig- The Amazon CloudWatch Logs configuration.- Returns:
this
-
logConfig
@Stability(Stable) public CfnGraphQLApiMixinProps.Builder logConfig(CfnGraphQLApiPropsMixin.LogConfigProperty logConfig) Sets the value ofCfnGraphQLApiMixinProps.getLogConfig()- Parameters:
logConfig- The Amazon CloudWatch Logs configuration.- Returns:
this
-
mergedApiExecutionRoleArn
@Stability(Stable) public CfnGraphQLApiMixinProps.Builder mergedApiExecutionRoleArn(String mergedApiExecutionRoleArn) Sets the value ofCfnGraphQLApiMixinProps.getMergedApiExecutionRoleArn()- Parameters:
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 theAUTO_MERGEto update the merged API endpoint with the source API changes automatically.- Returns:
this
-
name
Sets the value ofCfnGraphQLApiMixinProps.getName()- Parameters:
name- The API name.- Returns:
this
-
openIdConnectConfig
@Stability(Stable) public CfnGraphQLApiMixinProps.Builder openIdConnectConfig(IResolvable openIdConnectConfig) Sets the value ofCfnGraphQLApiMixinProps.getOpenIdConnectConfig()- Parameters:
openIdConnectConfig- The OpenID Connect configuration.- Returns:
this
-
openIdConnectConfig
@Stability(Stable) public CfnGraphQLApiMixinProps.Builder openIdConnectConfig(CfnGraphQLApiPropsMixin.OpenIDConnectConfigProperty openIdConnectConfig) Sets the value ofCfnGraphQLApiMixinProps.getOpenIdConnectConfig()- Parameters:
openIdConnectConfig- The OpenID Connect configuration.- Returns:
this
-
ownerContact
Sets the value ofCfnGraphQLApiMixinProps.getOwnerContact()- Parameters:
ownerContact- The owner contact information for an API resource. This field accepts any string input with a length of 0 - 256 characters.- Returns:
this
-
queryDepthLimit
Sets the value ofCfnGraphQLApiMixinProps.getQueryDepthLimit()- Parameters:
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 is0(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.- Returns:
this
-
resolverCountLimit
@Stability(Stable) public CfnGraphQLApiMixinProps.Builder resolverCountLimit(Number resolverCountLimit) Sets the value ofCfnGraphQLApiMixinProps.getResolverCountLimit()- Parameters:
resolverCountLimit- The maximum number of resolvers that can be invoked in a single request. The default value is0(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.- Returns:
this
-
tags
Sets the value ofCfnGraphQLApiMixinProps.getTags()- Parameters:
tags- An arbitrary set of tags (key-value pairs) for this GraphQL API.- Returns:
this
-
userPoolConfig
@Stability(Stable) public CfnGraphQLApiMixinProps.Builder userPoolConfig(IResolvable userPoolConfig) Sets the value ofCfnGraphQLApiMixinProps.getUserPoolConfig()- Parameters:
userPoolConfig- Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.- Returns:
this
-
userPoolConfig
@Stability(Stable) public CfnGraphQLApiMixinProps.Builder userPoolConfig(CfnGraphQLApiPropsMixin.UserPoolConfigProperty userPoolConfig) Sets the value ofCfnGraphQLApiMixinProps.getUserPoolConfig()- Parameters:
userPoolConfig- Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.- Returns:
this
-
visibility
Sets the value ofCfnGraphQLApiMixinProps.getVisibility()- Parameters:
visibility- Sets the scope of the GraphQL API to public (GLOBAL) or private (PRIVATE). By default, the scope is set toGlobalif 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.- Returns:
this
-
xrayEnabled
Sets the value ofCfnGraphQLApiMixinProps.getXrayEnabled()- Parameters:
xrayEnabled- A flag indicating whether to use AWS X-Ray tracing for thisGraphqlApi.- Returns:
this
-
xrayEnabled
Sets the value ofCfnGraphQLApiMixinProps.getXrayEnabled()- Parameters:
xrayEnabled- A flag indicating whether to use AWS X-Ray tracing for thisGraphqlApi.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnGraphQLApiMixinProps>- Returns:
- a new instance of
CfnGraphQLApiMixinProps - Throws:
NullPointerException- if any required attribute was not provided
-