software.amazon.awscdk.services.appsync

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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.678Z")
 @Stability(value=Stable)
public class CfnGraphQLApi
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppSync::GraphQLApi`.

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()))
         .lambdaAuthorizerConfig(LambdaAuthorizerConfigProperty.builder()
                 .authorizerResultTtlInSeconds(123)
                 .authorizerUri("authorizerUri")
                 .identityValidationExpression("identityValidationExpression")
                 .build())
         .logConfig(LogConfigProperty.builder()
                 .cloudWatchLogsRoleArn("cloudWatchLogsRoleArn")
                 .excludeVerboseContent(false)
                 .fieldLogLevel("fieldLogLevel")
                 .build())
         .openIdConnectConfig(OpenIDConnectConfigProperty.builder()
                 .authTtl(123)
                 .clientId("clientId")
                 .iatTtl(123)
                 .issuer("issuer")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .userPoolConfig(UserPoolConfigProperty.builder()
                 .appIdClientRegex("appIdClientRegex")
                 .awsRegion("awsRegion")
                 .defaultAction("defaultAction")
                 .userPoolId("userPoolId")
                 .build())
         .xrayEnabled(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnGraphQLApi.AdditionalAuthenticationProviderProperty Describes an additional authentication provider.
static class	CfnGraphQLApi.Builder A fluent builder for CfnGraphQLApi.
static interface	CfnGraphQLApi.CognitoUserPoolConfigProperty Describes an Amazon Cognito user pool configuration.
static interface	CfnGraphQLApi.LambdaAuthorizerConfigProperty Configuration for AWS Lambda function authorization.
static interface	CfnGraphQLApi.LogConfigProperty The `LogConfig` property type specifies the logging configuration when writing GraphQL operations and tracing to Amazon CloudWatch for an AWS AppSync GraphQL API.
static interface	CfnGraphQLApi.OpenIDConnectConfigProperty The `OpenIDConnectConfig` 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	CfnGraphQLApi.UserPoolConfigProperty The `UserPoolConfig` 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.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnGraphQLApi(software.constructs.Construct scope, String id, CfnGraphQLApiProps props) Create a new `AWS::AppSync::GraphQLApi`.
protected	CfnGraphQLApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnGraphQLApi(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAdditionalAuthenticationProviders() A list of additional authentication providers for the `GraphqlApi` API.
String	getAttrApiId() Unique AWS AppSync GraphQL API identifier.
String	getAttrArn() The Amazon Resource Name (ARN) of the API key, such as `arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid` .
String	getAttrGraphQlUrl() The Endpoint URL of your GraphQL API.
String	getAuthenticationType() Security configuration for your GraphQL API.
protected Map<String,Object>	getCfnProperties()
Object	getLambdaAuthorizerConfig() A `LambdaAuthorizerConfig` holds configuration on how to authorize AWS AppSync API access when using the `AWS_LAMBDA` authorizer mode.
Object	getLogConfig() The Amazon CloudWatch Logs configuration.
String	getName() The API name.
Object	getOpenIdConnectConfig() The OpenID Connect configuration.
TagManager	getTags() An arbitrary set of tags (key-value pairs) for this GraphQL API.
Object	getUserPoolConfig() Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
Object	getXrayEnabled() A flag indicating whether to use AWS X-Ray tracing for this `GraphqlApi` .
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAdditionalAuthenticationProviders(IResolvable value) A list of additional authentication providers for the `GraphqlApi` API.
void	setAdditionalAuthenticationProviders(List<Object> value) A list of additional authentication providers for the `GraphqlApi` API.
void	setAuthenticationType(String value) Security configuration for your GraphQL API.
void	setLambdaAuthorizerConfig(CfnGraphQLApi.LambdaAuthorizerConfigProperty value) A `LambdaAuthorizerConfig` holds configuration on how to authorize AWS AppSync API access when using the `AWS_LAMBDA` authorizer mode.
void	setLambdaAuthorizerConfig(IResolvable value) A `LambdaAuthorizerConfig` holds configuration on how to authorize AWS AppSync API access when using the `AWS_LAMBDA` authorizer mode.
void	setLogConfig(CfnGraphQLApi.LogConfigProperty value) The Amazon CloudWatch Logs configuration.
void	setLogConfig(IResolvable value) The Amazon CloudWatch Logs configuration.
void	setName(String value) The API name.
void	setOpenIdConnectConfig(CfnGraphQLApi.OpenIDConnectConfigProperty value) The OpenID Connect configuration.
void	setOpenIdConnectConfig(IResolvable value) The OpenID Connect configuration.
void	setUserPoolConfig(CfnGraphQLApi.UserPoolConfigProperty value) Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
void	setUserPoolConfig(IResolvable value) Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
void	setXrayEnabled(Boolean value) A flag indicating whether to use AWS X-Ray tracing for this `GraphqlApi` .
void	setXrayEnabled(IResolvable value) A flag indicating whether to use AWS X-Ray tracing for this `GraphqlApi` .

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnGraphQLApi

protected CfnGraphQLApi(software.amazon.jsii.JsiiObjectRef objRef)

CfnGraphQLApi

protected CfnGraphQLApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnGraphQLApi

@Stability(value=Stable)
public CfnGraphQLApi(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              CfnGraphQLApiProps props)

Create a new `AWS::AppSync::GraphQLApi`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrApiId

@Stability(value=Stable)
 @NotNull
public String getAttrApiId()

Unique AWS AppSync GraphQL API identifier.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the API key, such as `arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid` .

getAttrGraphQlUrl

@Stability(value=Stable)
 @NotNull
public String getAttrGraphQlUrl()

The Endpoint URL of your GraphQL API.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

An arbitrary set of tags (key-value pairs) for this GraphQL API.

getAuthenticationType

@Stability(value=Stable)
 @NotNull
public String getAuthenticationType()

Security configuration for your GraphQL API.

For allowed values (such as API_KEY , AWS_IAM , AMAZON_COGNITO_USER_POOLS , OPENID_CONNECT , or AWS_LAMBDA ), see Security in the AWS AppSync Developer Guide .

setAuthenticationType

@Stability(value=Stable)
public void setAuthenticationType(@NotNull
                                                           String value)

Security configuration for your GraphQL API.

For allowed values (such as API_KEY , AWS_IAM , AMAZON_COGNITO_USER_POOLS , OPENID_CONNECT , or AWS_LAMBDA ), see Security in the AWS AppSync Developer Guide .

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The API name.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The API name.

getAdditionalAuthenticationProviders

@Stability(value=Stable)
 @Nullable
public Object getAdditionalAuthenticationProviders()

A list of additional authentication providers for the `GraphqlApi` API.

setAdditionalAuthenticationProviders

@Stability(value=Stable)
public void setAdditionalAuthenticationProviders(@Nullable
                                                                          IResolvable value)

A list of additional authentication providers for the `GraphqlApi` API.

setAdditionalAuthenticationProviders

@Stability(value=Stable)
public void setAdditionalAuthenticationProviders(@Nullable
                                                                          List<Object> value)

A list of additional authentication providers for the `GraphqlApi` API.

getLambdaAuthorizerConfig

@Stability(value=Stable)
 @Nullable
public Object getLambdaAuthorizerConfig()

A `LambdaAuthorizerConfig` holds configuration on how to authorize AWS AppSync API access when using the `AWS_LAMBDA` authorizer mode.

Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.

setLambdaAuthorizerConfig

@Stability(value=Stable)
public void setLambdaAuthorizerConfig(@Nullable
                                                               CfnGraphQLApi.LambdaAuthorizerConfigProperty value)

A `LambdaAuthorizerConfig` holds configuration on how to authorize AWS AppSync API access when using the `AWS_LAMBDA` authorizer mode.

Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.

setLambdaAuthorizerConfig

@Stability(value=Stable)
public void setLambdaAuthorizerConfig(@Nullable
                                                               IResolvable value)

A `LambdaAuthorizerConfig` holds configuration on how to authorize AWS AppSync API access when using the `AWS_LAMBDA` authorizer mode.

Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.

getLogConfig

@Stability(value=Stable)
 @Nullable
public Object getLogConfig()

The Amazon CloudWatch Logs configuration.

setLogConfig

@Stability(value=Stable)
public void setLogConfig(@Nullable
                                                  CfnGraphQLApi.LogConfigProperty value)

The Amazon CloudWatch Logs configuration.

setLogConfig

@Stability(value=Stable)
public void setLogConfig(@Nullable
                                                  IResolvable value)

The Amazon CloudWatch Logs configuration.

getOpenIdConnectConfig

@Stability(value=Stable)
 @Nullable
public Object getOpenIdConnectConfig()

The OpenID Connect configuration.

setOpenIdConnectConfig

@Stability(value=Stable)
public void setOpenIdConnectConfig(@Nullable
                                                            CfnGraphQLApi.OpenIDConnectConfigProperty value)

The OpenID Connect configuration.

setOpenIdConnectConfig

@Stability(value=Stable)
public void setOpenIdConnectConfig(@Nullable
                                                            IResolvable value)

The OpenID Connect configuration.

getUserPoolConfig

@Stability(value=Stable)
 @Nullable
public Object getUserPoolConfig()

Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.

setUserPoolConfig

@Stability(value=Stable)
public void setUserPoolConfig(@Nullable
                                                       CfnGraphQLApi.UserPoolConfigProperty value)

Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.

setUserPoolConfig

@Stability(value=Stable)
public void setUserPoolConfig(@Nullable
                                                       IResolvable value)

Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.

getXrayEnabled

@Stability(value=Stable)
 @Nullable
public Object getXrayEnabled()

A flag indicating whether to use AWS X-Ray tracing for this `GraphqlApi` .

setXrayEnabled

@Stability(value=Stable)
public void setXrayEnabled(@Nullable
                                                    Boolean value)

A flag indicating whether to use AWS X-Ray tracing for this `GraphqlApi` .

setXrayEnabled

@Stability(value=Stable)
public void setXrayEnabled(@Nullable
                                                    IResolvable value)

A flag indicating whether to use AWS X-Ray tracing for this `GraphqlApi` .