CfnGraphQLApi

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.appsync.CfnGraphQLApi

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:37:02.267Z")
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 interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnGraphQLApi(Construct scope, java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`getAdditionalAuthenticationProviders()` A list of additional authentication providers for the `GraphqlApi` API.
`java.lang.String`	`getAttrApiId()` Unique AWS AppSync GraphQL API identifier.
`java.lang.String`	`getAttrArn()` The Amazon Resource Name (ARN) of the API key, such as `arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid` .
`java.lang.String`	`getAttrGraphQlUrl()` The Endpoint URL of your GraphQL API.
`java.lang.String`	`getAuthenticationType()` Security configuration for your GraphQL API.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.Object`	`getLambdaAuthorizerConfig()` A `LambdaAuthorizerConfig` holds configuration on how to authorize AWS AppSync API access when using the `AWS_LAMBDA` authorizer mode.
`java.lang.Object`	`getLogConfig()` The Amazon CloudWatch Logs configuration.
`java.lang.String`	`getName()` The API name.
`java.lang.Object`	`getOpenIdConnectConfig()` The OpenID Connect configuration.
`TagManager`	`getTags()` An arbitrary set of tags (key-value pairs) for this GraphQL API.
`java.lang.Object`	`getUserPoolConfig()` Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
`java.lang.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 java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setAdditionalAuthenticationProviders(IResolvable value)` A list of additional authentication providers for the `GraphqlApi` API.
`void`	`setAdditionalAuthenticationProviders(java.util.List<java.lang.Object> value)` A list of additional authentication providers for the `GraphqlApi` API.
`void`	`setAuthenticationType(java.lang.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(java.lang.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(java.lang.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.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.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
```
public CfnGraphQLApi(Construct scope,
                     java.lang.String id,
                     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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrApiId
```
public java.lang.String getAttrApiId()
```
    Unique AWS AppSync GraphQL API identifier.
  - getAttrArn
```
public java.lang.String getAttrArn()
```
    The Amazon Resource Name (ARN) of the API key, such as `arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid` .
  - getAttrGraphQlUrl
```
public java.lang.String getAttrGraphQlUrl()
```
    The Endpoint URL of your GraphQL API.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    An arbitrary set of tags (key-value pairs) for this GraphQL API.
  - getAuthenticationType
```
public java.lang.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
```
public void setAuthenticationType(java.lang.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
```
public java.lang.String getName()
```
    The API name.
  - setName
```
public void setName(java.lang.String value)
```
    The API name.
  - getAdditionalAuthenticationProviders
```
public java.lang.Object getAdditionalAuthenticationProviders()
```
    A list of additional authentication providers for the `GraphqlApi` API.
  - setAdditionalAuthenticationProviders
```
public void setAdditionalAuthenticationProviders(IResolvable value)
```
    A list of additional authentication providers for the `GraphqlApi` API.
  - setAdditionalAuthenticationProviders
```
public void setAdditionalAuthenticationProviders(java.util.List<java.lang.Object> value)
```
    A list of additional authentication providers for the `GraphqlApi` API.
  - getLambdaAuthorizerConfig
```
public java.lang.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
```
public void setLambdaAuthorizerConfig(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.
  - setLambdaAuthorizerConfig
```
public void setLambdaAuthorizerConfig(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.
  - getLogConfig
```
public java.lang.Object getLogConfig()
```
    The Amazon CloudWatch Logs configuration.
  - setLogConfig
```
public void setLogConfig(IResolvable value)
```
    The Amazon CloudWatch Logs configuration.
  - setLogConfig
```
public void setLogConfig(CfnGraphQLApi.LogConfigProperty value)
```
    The Amazon CloudWatch Logs configuration.
  - getOpenIdConnectConfig
```
public java.lang.Object getOpenIdConnectConfig()
```
    The OpenID Connect configuration.
  - setOpenIdConnectConfig
```
public void setOpenIdConnectConfig(IResolvable value)
```
    The OpenID Connect configuration.
  - setOpenIdConnectConfig
```
public void setOpenIdConnectConfig(CfnGraphQLApi.OpenIDConnectConfigProperty value)
```
    The OpenID Connect configuration.
  - getUserPoolConfig
```
public java.lang.Object getUserPoolConfig()
```
    Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
  - setUserPoolConfig
```
public void setUserPoolConfig(IResolvable value)
```
    Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
  - setUserPoolConfig
```
public void setUserPoolConfig(CfnGraphQLApi.UserPoolConfigProperty value)
```
    Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
  - getXrayEnabled
```
public java.lang.Object getXrayEnabled()
```
    A flag indicating whether to use AWS X-Ray tracing for this `GraphqlApi` .
  - setXrayEnabled
```
public void setXrayEnabled(java.lang.Boolean value)
```
    A flag indicating whether to use AWS X-Ray tracing for this `GraphqlApi` .
  - setXrayEnabled
```
public void setXrayEnabled(IResolvable value)
```
    A flag indicating whether to use AWS X-Ray tracing for this `GraphqlApi` .

Class CfnGraphQLApi

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnGraphQLApi

CfnGraphQLApi

CfnGraphQLApi

Method Detail

inspect

renderProperties

getAttrApiId

getAttrArn

getAttrGraphQlUrl

getCfnProperties

getTags

getAuthenticationType

setAuthenticationType

getName

setName

getAdditionalAuthenticationProviders

setAdditionalAuthenticationProviders

setAdditionalAuthenticationProviders

getLambdaAuthorizerConfig

setLambdaAuthorizerConfig

setLambdaAuthorizerConfig

getLogConfig

setLogConfig

setLogConfig

getOpenIdConnectConfig

setOpenIdConnectConfig

setOpenIdConnectConfig

getUserPoolConfig

setUserPoolConfig

setUserPoolConfig

getXrayEnabled

setXrayEnabled

setXrayEnabled