1.204.0

class CfnGraphQLApi (construct)

LanguageType name
.NETAmazon.CDK.AWS.AppSync.CfnGraphQLApi
Javasoftware.amazon.awscdk.services.appsync.CfnGraphQLApi
Pythonaws_cdk.aws_appsync.CfnGraphQLApi
TypeScript @aws-cdk/aws-appsync » CfnGraphQLApi

Implements IConstruct, IConstruct, IDependable, 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 * as appsync from '@aws-cdk/aws-appsync';
const cfnGraphQLApi = new appsync.CfnGraphQLApi(this, 'MyCfnGraphQLApi', {
  authenticationType: 'authenticationType',
  name: 'name',

  // the properties below are optional
  additionalAuthenticationProviders: [{
    authenticationType: 'authenticationType',

    // the properties below are optional
    lambdaAuthorizerConfig: {
      authorizerResultTtlInSeconds: 123,
      authorizerUri: 'authorizerUri',
      identityValidationExpression: 'identityValidationExpression',
    },
    openIdConnectConfig: {
      authTtl: 123,
      clientId: 'clientId',
      iatTtl: 123,
      issuer: 'issuer',
    },
    userPoolConfig: {
      appIdClientRegex: 'appIdClientRegex',
      awsRegion: 'awsRegion',
      userPoolId: 'userPoolId',
    },
  }],
  apiType: 'apiType',
  lambdaAuthorizerConfig: {
    authorizerResultTtlInSeconds: 123,
    authorizerUri: 'authorizerUri',
    identityValidationExpression: 'identityValidationExpression',
  },
  logConfig: {
    cloudWatchLogsRoleArn: 'cloudWatchLogsRoleArn',
    excludeVerboseContent: false,
    fieldLogLevel: 'fieldLogLevel',
  },
  mergedApiExecutionRoleArn: 'mergedApiExecutionRoleArn',
  openIdConnectConfig: {
    authTtl: 123,
    clientId: 'clientId',
    iatTtl: 123,
    issuer: 'issuer',
  },
  ownerContact: 'ownerContact',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  userPoolConfig: {
    appIdClientRegex: 'appIdClientRegex',
    awsRegion: 'awsRegion',
    defaultAction: 'defaultAction',
    userPoolId: 'userPoolId',
  },
  visibility: 'visibility',
  xrayEnabled: false,
});

Initializer

new CfnGraphQLApi(scope: Construct, id: string, props: CfnGraphQLApiProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnGraphQLApiProps — - resource properties.

Create a new AWS::AppSync::GraphQLApi.

Construct Props

NameTypeDescription
authenticationTypestringSecurity configuration for your GraphQL API.
namestringThe API name.
additionalAuthenticationProviders?IResolvable | IResolvable | AdditionalAuthenticationProviderProperty[]A list of additional authentication providers for the GraphqlApi API.
apiType?stringThe value that indicates whether the GraphQL API is a standard API ( GRAPHQL ) or merged API ( MERGED ).
lambdaAuthorizerConfig?IResolvable | LambdaAuthorizerConfigPropertyA LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.
logConfig?IResolvable | LogConfigPropertyThe Amazon CloudWatch Logs configuration.
mergedApiExecutionRoleArn?stringThe AWS Identity and Access Management service role ARN for a merged API.
openIdConnectConfig?IResolvable | OpenIDConnectConfigPropertyThe OpenID Connect configuration.
ownerContact?stringThe owner contact information for an API resource.
tags?CfnTag[]An arbitrary set of tags (key-value pairs) for this GraphQL API.
userPoolConfig?IResolvable | UserPoolConfigPropertyOptional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
visibility?stringSets the scope of the GraphQL API to public ( GLOBAL ) or private ( PRIVATE ).
xrayEnabled?boolean | IResolvableA flag indicating whether to use AWS X-Ray tracing for this GraphqlApi .

authenticationType

Type: string

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 .

name

Type: string

The API name.

additionalAuthenticationProviders?

Type: IResolvable | IResolvable | AdditionalAuthenticationProviderProperty[] (optional)

A list of additional authentication providers for the GraphqlApi API.

apiType?

Type: string (optional)

The value that indicates whether the GraphQL API is a standard API ( GRAPHQL ) or merged API ( MERGED ).

The following values are valid:

GRAPHQL | MERGED

lambdaAuthorizerConfig?

Type: IResolvable | LambdaAuthorizerConfigProperty (optional)

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.

logConfig?

Type: IResolvable | LogConfigProperty (optional)

The Amazon CloudWatch Logs configuration.

mergedApiExecutionRoleArn?

Type: string (optional)

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_MERGE to update the merged API endpoint with the source API changes automatically.

openIdConnectConfig?

Type: IResolvable | OpenIDConnectConfigProperty (optional)

The OpenID Connect configuration.

ownerContact?

Type: string (optional)

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

tags?

Type: CfnTag[] (optional)

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

userPoolConfig?

Type: IResolvable | UserPoolConfigProperty (optional)

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

visibility?

Type: string (optional)

Sets the scope of the GraphQL API to public ( GLOBAL ) or private ( PRIVATE ).

By default, the scope is set to Global if no value is provided.

xrayEnabled?

Type: boolean | IResolvable (optional)

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

Properties

NameTypeDescription
attrApiIdstringUnique AWS AppSync GraphQL API identifier.
attrArnstringThe Amazon Resource Name (ARN) of the API key, such as arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid .
attrGraphQlDnsstringThe fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API.
attrGraphQlUrlstringThe Endpoint URL of your GraphQL API.
attrRealtimeDnsstringThe fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL API.
attrRealtimeUrlstringThe GraphQL API real-time endpoint URL.
authenticationTypestringSecurity configuration for your GraphQL API.
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
logicalIdstringThe logical ID for this CloudFormation stack element.
namestringThe API name.
nodeConstructNodeThe construct tree node associated with this construct.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
stackStackThe stack in which this element is defined.
tagsTagManagerAn arbitrary set of tags (key-value pairs) for this GraphQL API.
additionalAuthenticationProviders?IResolvable | IResolvable | AdditionalAuthenticationProviderProperty[]A list of additional authentication providers for the GraphqlApi API.
apiType?stringThe value that indicates whether the GraphQL API is a standard API ( GRAPHQL ) or merged API ( MERGED ).
lambdaAuthorizerConfig?IResolvable | LambdaAuthorizerConfigPropertyA LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.
logConfig?IResolvable | LogConfigPropertyThe Amazon CloudWatch Logs configuration.
mergedApiExecutionRoleArn?stringThe AWS Identity and Access Management service role ARN for a merged API.
openIdConnectConfig?IResolvable | OpenIDConnectConfigPropertyThe OpenID Connect configuration.
ownerContact?stringThe owner contact information for an API resource.
userPoolConfig?IResolvable | UserPoolConfigPropertyOptional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
visibility?stringSets the scope of the GraphQL API to public ( GLOBAL ) or private ( PRIVATE ).
xrayEnabled?boolean | IResolvableA flag indicating whether to use AWS X-Ray tracing for this GraphqlApi .
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

attrApiId

Type: string

Unique AWS AppSync GraphQL API identifier.

attrArn

Type: string

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

attrGraphQlDns

Type: string

The fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API.

attrGraphQlUrl

Type: string

The Endpoint URL of your GraphQL API.

attrRealtimeDns

Type: string

The fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL API.

attrRealtimeUrl

Type: string

The GraphQL API real-time endpoint URL.

For more information, see Discovering the real-time endpoint from the GraphQL endpoint .

authenticationType

Type: string

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 .

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

name

Type: string

The API name.

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

Type: TagManager

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

additionalAuthenticationProviders?

Type: IResolvable | IResolvable | AdditionalAuthenticationProviderProperty[] (optional)

A list of additional authentication providers for the GraphqlApi API.

apiType?

Type: string (optional)

The value that indicates whether the GraphQL API is a standard API ( GRAPHQL ) or merged API ( MERGED ).

The following values are valid:

GRAPHQL | MERGED

lambdaAuthorizerConfig?

Type: IResolvable | LambdaAuthorizerConfigProperty (optional)

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.

logConfig?

Type: IResolvable | LogConfigProperty (optional)

The Amazon CloudWatch Logs configuration.

mergedApiExecutionRoleArn?

Type: string (optional)

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_MERGE to update the merged API endpoint with the source API changes automatically.

openIdConnectConfig?

Type: IResolvable | OpenIDConnectConfigProperty (optional)

The OpenID Connect configuration.

ownerContact?

Type: string (optional)

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

userPoolConfig?

Type: IResolvable | UserPoolConfigProperty (optional)

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

visibility?

Type: string (optional)

Sets the scope of the GraphQL API to public ( GLOBAL ) or private ( PRIVATE ).

By default, the scope is set to Global if no value is provided.

xrayEnabled?

Type: boolean | IResolvable (optional)

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

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependsOn(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

  • attributeName string — The name of the attribute.

Returns

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }
← PreviousNext →