Class CfnGraphQLApi
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.appsync.CfnGraphQLApi
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-13T21:17:29.025Z")
@Stability(Stable)
public class CfnGraphQLApi
extends CfnResource
implements IInspectable, ITaggable
The
AWS::AppSync::GraphQLApi
resource creates a new AWS AppSync GraphQL API.
This is the top-level construct for your application. For more information, see Quick Start in the AWS AppSync Developer Guide .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.appsync.*; CfnGraphQLApi cfnGraphQLApi = CfnGraphQLApi.Builder.create(this, "MyCfnGraphQLApi") .authenticationType("authenticationType") .name("name") // the properties below are optional .additionalAuthenticationProviders(List.of(AdditionalAuthenticationProviderProperty.builder() .authenticationType("authenticationType") // the properties below are optional .lambdaAuthorizerConfig(LambdaAuthorizerConfigProperty.builder() .authorizerResultTtlInSeconds(123) .authorizerUri("authorizerUri") .identityValidationExpression("identityValidationExpression") .build()) .openIdConnectConfig(OpenIDConnectConfigProperty.builder() .authTtl(123) .clientId("clientId") .iatTtl(123) .issuer("issuer") .build()) .userPoolConfig(CognitoUserPoolConfigProperty.builder() .appIdClientRegex("appIdClientRegex") .awsRegion("awsRegion") .userPoolId("userPoolId") .build()) .build())) .apiType("apiType") .enhancedMetricsConfig(EnhancedMetricsConfigProperty.builder() .dataSourceLevelMetricsBehavior("dataSourceLevelMetricsBehavior") .operationLevelMetricsConfig("operationLevelMetricsConfig") .resolverLevelMetricsBehavior("resolverLevelMetricsBehavior") .build()) .environmentVariables(Map.of( "environmentVariablesKey", "environmentVariables")) .introspectionConfig("introspectionConfig") .lambdaAuthorizerConfig(LambdaAuthorizerConfigProperty.builder() .authorizerResultTtlInSeconds(123) .authorizerUri("authorizerUri") .identityValidationExpression("identityValidationExpression") .build()) .logConfig(LogConfigProperty.builder() .cloudWatchLogsRoleArn("cloudWatchLogsRoleArn") .excludeVerboseContent(false) .fieldLogLevel("fieldLogLevel") .build()) .mergedApiExecutionRoleArn("mergedApiExecutionRoleArn") .openIdConnectConfig(OpenIDConnectConfigProperty.builder() .authTtl(123) .clientId("clientId") .iatTtl(123) .issuer("issuer") .build()) .ownerContact("ownerContact") .queryDepthLimit(123) .resolverCountLimit(123) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .userPoolConfig(UserPoolConfigProperty.builder() .appIdClientRegex("appIdClientRegex") .awsRegion("awsRegion") .defaultAction("defaultAction") .userPoolId("userPoolId") .build()) .visibility("visibility") .xrayEnabled(false) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Describes an additional authentication provider.static final class
A fluent builder forCfnGraphQLApi
.static interface
Describes an Amazon Cognito user pool configuration.static interface
Describes an enhanced metrics configuration.static interface
Configuration for AWS Lambda function authorization.static interface
TheLogConfig
property type specifies the logging configuration when writing GraphQL operations and tracing to Amazon CloudWatch for an AWS AppSync GraphQL API.static interface
TheOpenIDConnectConfig
property type specifies the optional authorization configuration for using an OpenID Connect compliant service with your GraphQL endpoint for an AWS AppSync GraphQL API.static interface
TheUserPoolConfig
property type specifies the optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint for an AWS AppSync GraphQL API.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnGraphQLApi
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnGraphQLApi
(software.amazon.jsii.JsiiObjectRef objRef) CfnGraphQLApi
(software.constructs.Construct scope, String id, CfnGraphQLApiProps props) -
Method Summary
Modifier and TypeMethodDescriptionA list of additional authentication providers for theGraphqlApi
API.The value that indicates whether the GraphQL API is a standard API (GRAPHQL
) or merged API (MERGED
).Unique AWS AppSync GraphQL API identifier.The Amazon Resource Name (ARN) of the API key, such asarn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid
.The fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API.The GraphQL endpoint ARN.The Endpoint URL of your GraphQL API.The fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL API.The GraphQL API real-time endpoint URL.Security configuration for your GraphQL API.Enables and controls the enhanced metrics feature.A map containing the list of resources with their properties and environment variables.Sets the value of the GraphQL API to enable (ENABLED
) or disable (DISABLED
) introspection.ALambdaAuthorizerConfig
holds configuration on how to authorize AWS AppSync API access when using theAWS_LAMBDA
authorizer mode.The Amazon CloudWatch Logs configuration.The AWS Identity and Access Management service role ARN for a merged API.getName()
The API name.The OpenID Connect configuration.The owner contact information for an API resource.The maximum depth a query can have in a single request.The maximum number of resolvers that can be invoked in a single request.getTags()
Tag Manager which manages the tags for this resource.An arbitrary set of tags (key-value pairs) for this GraphQL API.Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.Sets the scope of the GraphQL API to public (GLOBAL
) or private (PRIVATE
).A flag indicating whether to use AWS X-Ray tracing for thisGraphqlApi
.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
A list of additional authentication providers for theGraphqlApi
API.void
A list of additional authentication providers for theGraphqlApi
API.void
setApiType
(String value) The value that indicates whether the GraphQL API is a standard API (GRAPHQL
) or merged API (MERGED
).void
setAuthenticationType
(String value) Security configuration for your GraphQL API.void
Enables and controls the enhanced metrics feature.void
Enables and controls the enhanced metrics feature.void
setEnvironmentVariables
(Map<String, String> value) A map containing the list of resources with their properties and environment variables.void
A map containing the list of resources with their properties and environment variables.void
setIntrospectionConfig
(String value) Sets the value of the GraphQL API to enable (ENABLED
) or disable (DISABLED
) introspection.void
ALambdaAuthorizerConfig
holds configuration on how to authorize AWS AppSync API access when using theAWS_LAMBDA
authorizer mode.void
ALambdaAuthorizerConfig
holds configuration on how to authorize AWS AppSync API access when using theAWS_LAMBDA
authorizer mode.void
setLogConfig
(IResolvable value) The Amazon CloudWatch Logs configuration.void
The Amazon CloudWatch Logs configuration.void
The AWS Identity and Access Management service role ARN for a merged API.void
The API name.void
The OpenID Connect configuration.void
The OpenID Connect configuration.void
setOwnerContact
(String value) The owner contact information for an API resource.void
setQueryDepthLimit
(Number value) The maximum depth a query can have in a single request.void
setResolverCountLimit
(Number value) The maximum number of resolvers that can be invoked in a single request.void
setTagsRaw
(List<CfnTag> value) An arbitrary set of tags (key-value pairs) for this GraphQL API.void
setUserPoolConfig
(IResolvable value) Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.void
Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.void
setVisibility
(String value) Sets the scope of the GraphQL API to public (GLOBAL
) or private (PRIVATE
).void
setXrayEnabled
(Boolean value) A flag indicating whether to use AWS X-Ray tracing for thisGraphqlApi
.void
setXrayEnabled
(IResolvable value) A flag indicating whether to use AWS X-Ray tracing for thisGraphqlApi
.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnGraphQLApi
protected CfnGraphQLApi(software.amazon.jsii.JsiiObjectRef objRef) -
CfnGraphQLApi
protected CfnGraphQLApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnGraphQLApi
@Stability(Stable) public CfnGraphQLApi(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnGraphQLApiProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrApiId
Unique AWS AppSync GraphQL API identifier. -
getAttrArn
The Amazon Resource Name (ARN) of the API key, such asarn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid
. -
getAttrGraphQlDns
The fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API. -
getAttrGraphQlEndpointArn
The GraphQL endpoint ARN. -
getAttrGraphQlUrl
The Endpoint URL of your GraphQL API. -
getAttrId
-
getAttrRealtimeDns
The fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL API. -
getAttrRealtimeUrl
The GraphQL API real-time endpoint URL.For more information, see Discovering the real-time endpoint from the GraphQL endpoint .
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getAuthenticationType
Security configuration for your GraphQL API. -
setAuthenticationType
Security configuration for your GraphQL API. -
getName
The API name. -
setName
The API name. -
getAdditionalAuthenticationProviders
A list of additional authentication providers for theGraphqlApi
API. -
setAdditionalAuthenticationProviders
A list of additional authentication providers for theGraphqlApi
API. -
setAdditionalAuthenticationProviders
A list of additional authentication providers for theGraphqlApi
API. -
getApiType
The value that indicates whether the GraphQL API is a standard API (GRAPHQL
) or merged API (MERGED
). -
setApiType
The value that indicates whether the GraphQL API is a standard API (GRAPHQL
) or merged API (MERGED
). -
getEnhancedMetricsConfig
Enables and controls the enhanced metrics feature. -
setEnhancedMetricsConfig
Enables and controls the enhanced metrics feature. -
setEnhancedMetricsConfig
@Stability(Stable) public void setEnhancedMetricsConfig(@Nullable CfnGraphQLApi.EnhancedMetricsConfigProperty value) Enables and controls the enhanced metrics feature. -
getEnvironmentVariables
A map containing the list of resources with their properties and environment variables. -
setEnvironmentVariables
A map containing the list of resources with their properties and environment variables. -
setEnvironmentVariables
A map containing the list of resources with their properties and environment variables. -
getIntrospectionConfig
Sets the value of the GraphQL API to enable (ENABLED
) or disable (DISABLED
) introspection. -
setIntrospectionConfig
Sets the value of the GraphQL API to enable (ENABLED
) or disable (DISABLED
) introspection. -
getLambdaAuthorizerConfig
ALambdaAuthorizerConfig
holds configuration on how to authorize AWS AppSync API access when using theAWS_LAMBDA
authorizer mode. -
setLambdaAuthorizerConfig
ALambdaAuthorizerConfig
holds configuration on how to authorize AWS AppSync API access when using theAWS_LAMBDA
authorizer mode. -
setLambdaAuthorizerConfig
@Stability(Stable) public void setLambdaAuthorizerConfig(@Nullable CfnGraphQLApi.LambdaAuthorizerConfigProperty value) ALambdaAuthorizerConfig
holds configuration on how to authorize AWS AppSync API access when using theAWS_LAMBDA
authorizer mode. -
getLogConfig
The Amazon CloudWatch Logs configuration. -
setLogConfig
The Amazon CloudWatch Logs configuration. -
setLogConfig
The Amazon CloudWatch Logs configuration. -
getMergedApiExecutionRoleArn
The AWS Identity and Access Management service role ARN for a merged API. -
setMergedApiExecutionRoleArn
The AWS Identity and Access Management service role ARN for a merged API. -
getOpenIdConnectConfig
The OpenID Connect configuration. -
setOpenIdConnectConfig
The OpenID Connect configuration. -
setOpenIdConnectConfig
@Stability(Stable) public void setOpenIdConnectConfig(@Nullable CfnGraphQLApi.OpenIDConnectConfigProperty value) The OpenID Connect configuration. -
getOwnerContact
The owner contact information for an API resource. -
setOwnerContact
The owner contact information for an API resource. -
getQueryDepthLimit
The maximum depth a query can have in a single request. -
setQueryDepthLimit
The maximum depth a query can have in a single request. -
getResolverCountLimit
The maximum number of resolvers that can be invoked in a single request. -
setResolverCountLimit
The maximum number of resolvers that can be invoked in a single request. -
getTagsRaw
An arbitrary set of tags (key-value pairs) for this GraphQL API. -
setTagsRaw
An arbitrary set of tags (key-value pairs) for this GraphQL API. -
getUserPoolConfig
Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint. -
setUserPoolConfig
Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint. -
setUserPoolConfig
@Stability(Stable) public void setUserPoolConfig(@Nullable CfnGraphQLApi.UserPoolConfigProperty value) Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint. -
getVisibility
Sets the scope of the GraphQL API to public (GLOBAL
) or private (PRIVATE
). -
setVisibility
Sets the scope of the GraphQL API to public (GLOBAL
) or private (PRIVATE
). -
getXrayEnabled
A flag indicating whether to use AWS X-Ray tracing for thisGraphqlApi
. -
setXrayEnabled
A flag indicating whether to use AWS X-Ray tracing for thisGraphqlApi
. -
setXrayEnabled
A flag indicating whether to use AWS X-Ray tracing for thisGraphqlApi
.
-