CfnGraphQLApi L1 construct
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
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';
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',
enhancedMetricsConfig: {
dataSourceLevelMetricsBehavior: 'dataSourceLevelMetricsBehavior',
operationLevelMetricsConfig: 'operationLevelMetricsConfig',
resolverLevelMetricsBehavior: 'resolverLevelMetricsBehavior',
},
environmentVariables: {
environmentVariablesKey: 'environmentVariables',
},
introspectionConfig: 'introspectionConfig',
lambdaAuthorizerConfig: {
authorizerResultTtlInSeconds: 123,
authorizerUri: 'authorizerUri',
identityValidationExpression: 'identityValidationExpression',
},
logConfig: {
cloudWatchLogsRoleArn: 'cloudWatchLogsRoleArn',
fieldLogLevel: 'fieldLogLevel',
// the properties below are optional
excludeVerboseContent: false,
},
mergedApiExecutionRoleArn: 'mergedApiExecutionRoleArn',
openIdConnectConfig: {
authTtl: 123,
clientId: 'clientId',
iatTtl: 123,
issuer: 'issuer',
},
ownerContact: 'ownerContact',
queryDepthLimit: 123,
resolverCountLimit: 123,
tags: [{
key: 'key',
value: 'value',
}],
userPoolConfig: {
appIdClientRegex: 'appIdClientRegex',
awsRegion: 'awsRegion',
defaultAction: 'defaultAction',
userPoolId: 'userPoolId',
},
visibility: 'visibility',
xrayEnabled: false,
});
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appsync as appsync
cfn_graph_ql_api = appsync.CfnGraphQLApi(self, "MyCfnGraphQLApi",
authentication_type="authenticationType",
name="name",
# the properties below are optional
additional_authentication_providers=[appsync.CfnGraphQLApi.AdditionalAuthenticationProviderProperty(
authentication_type="authenticationType",
# the properties below are optional
lambda_authorizer_config=appsync.CfnGraphQLApi.LambdaAuthorizerConfigProperty(
authorizer_result_ttl_in_seconds=123,
authorizer_uri="authorizerUri",
identity_validation_expression="identityValidationExpression"
),
open_id_connect_config=appsync.CfnGraphQLApi.OpenIDConnectConfigProperty(
auth_ttl=123,
client_id="clientId",
iat_ttl=123,
issuer="issuer"
),
user_pool_config=appsync.CfnGraphQLApi.CognitoUserPoolConfigProperty(
app_id_client_regex="appIdClientRegex",
aws_region="awsRegion",
user_pool_id="userPoolId"
)
)],
api_type="apiType",
enhanced_metrics_config=appsync.CfnGraphQLApi.EnhancedMetricsConfigProperty(
data_source_level_metrics_behavior="dataSourceLevelMetricsBehavior",
operation_level_metrics_config="operationLevelMetricsConfig",
resolver_level_metrics_behavior="resolverLevelMetricsBehavior"
),
environment_variables={
"environment_variables_key": "environmentVariables"
},
introspection_config="introspectionConfig",
lambda_authorizer_config=appsync.CfnGraphQLApi.LambdaAuthorizerConfigProperty(
authorizer_result_ttl_in_seconds=123,
authorizer_uri="authorizerUri",
identity_validation_expression="identityValidationExpression"
),
log_config=appsync.CfnGraphQLApi.LogConfigProperty(
cloud_watch_logs_role_arn="cloudWatchLogsRoleArn",
field_log_level="fieldLogLevel",
# the properties below are optional
exclude_verbose_content=False
),
merged_api_execution_role_arn="mergedApiExecutionRoleArn",
open_id_connect_config=appsync.CfnGraphQLApi.OpenIDConnectConfigProperty(
auth_ttl=123,
client_id="clientId",
iat_ttl=123,
issuer="issuer"
),
owner_contact="ownerContact",
query_depth_limit=123,
resolver_count_limit=123,
tags=[CfnTag(
key="key",
value="value"
)],
user_pool_config=appsync.CfnGraphQLApi.UserPoolConfigProperty(
app_id_client_regex="appIdClientRegex",
aws_region="awsRegion",
default_action="defaultAction",
user_pool_id="userPoolId"
),
visibility="visibility",
xray_enabled=False
)
java
// 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")
.fieldLogLevel("fieldLogLevel")
// the properties below are optional
.excludeVerboseContent(false)
.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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppSync;
var cfnGraphQLApi = new CfnGraphQLApi(this, "MyCfnGraphQLApi", new CfnGraphQLApiProps {
AuthenticationType = "authenticationType",
Name = "name",
// the properties below are optional
AdditionalAuthenticationProviders = new [] { new AdditionalAuthenticationProviderProperty {
AuthenticationType = "authenticationType",
// the properties below are optional
LambdaAuthorizerConfig = new LambdaAuthorizerConfigProperty {
AuthorizerResultTtlInSeconds = 123,
AuthorizerUri = "authorizerUri",
IdentityValidationExpression = "identityValidationExpression"
},
OpenIdConnectConfig = new OpenIDConnectConfigProperty {
AuthTtl = 123,
ClientId = "clientId",
IatTtl = 123,
Issuer = "issuer"
},
UserPoolConfig = new CognitoUserPoolConfigProperty {
AppIdClientRegex = "appIdClientRegex",
AwsRegion = "awsRegion",
UserPoolId = "userPoolId"
}
} },
ApiType = "apiType",
EnhancedMetricsConfig = new EnhancedMetricsConfigProperty {
DataSourceLevelMetricsBehavior = "dataSourceLevelMetricsBehavior",
OperationLevelMetricsConfig = "operationLevelMetricsConfig",
ResolverLevelMetricsBehavior = "resolverLevelMetricsBehavior"
},
EnvironmentVariables = new Dictionary<string, string> {
{ "environmentVariablesKey", "environmentVariables" }
},
IntrospectionConfig = "introspectionConfig",
LambdaAuthorizerConfig = new LambdaAuthorizerConfigProperty {
AuthorizerResultTtlInSeconds = 123,
AuthorizerUri = "authorizerUri",
IdentityValidationExpression = "identityValidationExpression"
},
LogConfig = new LogConfigProperty {
CloudWatchLogsRoleArn = "cloudWatchLogsRoleArn",
FieldLogLevel = "fieldLogLevel",
// the properties below are optional
ExcludeVerboseContent = false
},
MergedApiExecutionRoleArn = "mergedApiExecutionRoleArn",
OpenIdConnectConfig = new OpenIDConnectConfigProperty {
AuthTtl = 123,
ClientId = "clientId",
IatTtl = 123,
Issuer = "issuer"
},
OwnerContact = "ownerContact",
QueryDepthLimit = 123,
ResolverCountLimit = 123,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
UserPoolConfig = new UserPoolConfigProperty {
AppIdClientRegex = "appIdClientRegex",
AwsRegion = "awsRegion",
DefaultAction = "defaultAction",
UserPoolId = "userPoolId"
},
Visibility = "visibility",
XrayEnabled = false
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnGraphQLApi := awscdk.Aws_appsync.NewCfnGraphQLApi(this, jsii.String("MyCfnGraphQLApi"), &CfnGraphQLApiProps{
AuthenticationType: jsii.String("authenticationType"),
Name: jsii.String("name"),
// the properties below are optional
AdditionalAuthenticationProviders: []interface{}{
&AdditionalAuthenticationProviderProperty{
AuthenticationType: jsii.String("authenticationType"),
// the properties below are optional
LambdaAuthorizerConfig: &LambdaAuthorizerConfigProperty{
AuthorizerResultTtlInSeconds: jsii.Number(123),
AuthorizerUri: jsii.String("authorizerUri"),
IdentityValidationExpression: jsii.String("identityValidationExpression"),
},
OpenIdConnectConfig: &OpenIDConnectConfigProperty{
AuthTtl: jsii.Number(123),
ClientId: jsii.String("clientId"),
IatTtl: jsii.Number(123),
Issuer: jsii.String("issuer"),
},
UserPoolConfig: &CognitoUserPoolConfigProperty{
AppIdClientRegex: jsii.String("appIdClientRegex"),
AwsRegion: jsii.String("awsRegion"),
UserPoolId: jsii.String("userPoolId"),
},
},
},
ApiType: jsii.String("apiType"),
EnhancedMetricsConfig: &EnhancedMetricsConfigProperty{
DataSourceLevelMetricsBehavior: jsii.String("dataSourceLevelMetricsBehavior"),
OperationLevelMetricsConfig: jsii.String("operationLevelMetricsConfig"),
ResolverLevelMetricsBehavior: jsii.String("resolverLevelMetricsBehavior"),
},
EnvironmentVariables: map[string]*string{
"environmentVariablesKey": jsii.String("environmentVariables"),
},
IntrospectionConfig: jsii.String("introspectionConfig"),
LambdaAuthorizerConfig: &LambdaAuthorizerConfigProperty{
AuthorizerResultTtlInSeconds: jsii.Number(123),
AuthorizerUri: jsii.String("authorizerUri"),
IdentityValidationExpression: jsii.String("identityValidationExpression"),
},
LogConfig: &LogConfigProperty{
CloudWatchLogsRoleArn: jsii.String("cloudWatchLogsRoleArn"),
FieldLogLevel: jsii.String("fieldLogLevel"),
// the properties below are optional
ExcludeVerboseContent: jsii.Boolean(false),
},
MergedApiExecutionRoleArn: jsii.String("mergedApiExecutionRoleArn"),
OpenIdConnectConfig: &OpenIDConnectConfigProperty{
AuthTtl: jsii.Number(123),
ClientId: jsii.String("clientId"),
IatTtl: jsii.Number(123),
Issuer: jsii.String("issuer"),
},
OwnerContact: jsii.String("ownerContact"),
QueryDepthLimit: jsii.Number(123),
ResolverCountLimit: jsii.Number(123),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
UserPoolConfig: &UserPoolConfigProperty{
AppIdClientRegex: jsii.String("appIdClientRegex"),
AwsRegion: jsii.String("awsRegion"),
DefaultAction: jsii.String("defaultAction"),
UserPoolId: jsii.String("userPoolId"),
},
Visibility: jsii.String("visibility"),
XrayEnabled: jsii.Boolean(false),
})
Initializer
ts
new CfnGraphQLApi(scope: Construct, id: string, props: CfnGraphQLApiProps)
python
CfnGraphQLApi(scope: Construct, id: str, props: CfnGraphQLApiProps)
java
new CfnGraphQLApi(Construct scope, String id, CfnGraphQLApiProps props)
csharp
new CfnGraphQLApi(Construct scope, string id, CfnGraphQLApiProps props)
go
NewCfnGraphQLApi(Scope Construct, Id *string, Props CfnGraphQLApiProps)
Construct Props
additionalAuthenticationProvidersoptionalIResolvable | IResolvable | CfnGraphQLApi.AdditionalAuthenticationProviderProperty[]additional_authentication_providersoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AdditionalAuthenticationProviderProperty]]]additionalAuthenticationProvidersoptionalIResolvableAdditionalAuthenticationProvidersoptionalIResolvableAdditionalAuthenticationProvidersoptionalinterface{}#A list of additional authentication providers for the `GraphqlApi` API.
apiTypeoptionalstringapi_typeoptionalstrapiTypeoptionalStringApiTypeoptionalstringApiTypeoptional*string#The value that indicates whether the GraphQL API is a standard API ( `GRAPHQL` ) or merged API ( `MERGED` ).
WARNING : If the ApiType has not been defined, explicitly setting it to GRAPHQL in a template/stack update will result in an API replacement and new DNS values.
The following values are valid:
GRAPHQL | MERGED
authenticationTypestringauthentication_typestrauthenticationTypeStringAuthenticationTypestringAuthenticationType*stringrequired#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 .
enhancedMetricsConfigoptionalIResolvable | CfnGraphQLApi.EnhancedMetricsConfigPropertyenhanced_metrics_configoptionaltyping.Union[IResolvable, EnhancedMetricsConfigProperty]enhancedMetricsConfigoptionalIResolvableEnhancedMetricsConfigoptionalIResolvableEnhancedMetricsConfigoptionalinterface{}#Enables and controls the enhanced metrics feature.
notes
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 .
environmentVariablesoptionalIResolvable | { [key: string]: string }environment_variablesoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]environmentVariablesoptionalIResolvableEnvironmentVariablesoptionalIResolvableEnvironmentVariablesoptionalinterface{}#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
introspectionConfigoptionalstringintrospection_configoptionalstrintrospectionConfigoptionalStringIntrospectionConfigoptionalstringIntrospectionConfigoptional*string#Sets the value of the GraphQL API to enable ( `ENABLED` ) or disable ( `DISABLED` ) introspection.
notes
If no value is provided, the introspection configuration will be set to ENABLED by 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 .
lambdaAuthorizerConfigoptionalIResolvable | CfnGraphQLApi.LambdaAuthorizerConfigPropertylambda_authorizer_configoptionaltyping.Union[IResolvable, LambdaAuthorizerConfigProperty]lambdaAuthorizerConfigoptionalIResolvableLambdaAuthorizerConfigoptionalIResolvableLambdaAuthorizerConfigoptionalinterface{}#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.
logConfigoptionalIResolvable | CfnGraphQLApi.LogConfigPropertylog_configoptionaltyping.Union[IResolvable, LogConfigProperty]logConfigoptionalIResolvableLogConfigoptionalIResolvableLogConfigoptionalinterface{}#The Amazon CloudWatch Logs configuration.
mergedApiExecutionRoleArnoptionalstringmerged_api_execution_role_arnoptionalstrmergedApiExecutionRoleArnoptionalStringMergedApiExecutionRoleArnoptionalstringMergedApiExecutionRoleArnoptional*string#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.
The API name.
openIdConnectConfigoptionalIResolvable | CfnGraphQLApi.OpenIDConnectConfigPropertyopen_id_connect_configoptionaltyping.Union[IResolvable, OpenIDConnectConfigProperty]openIdConnectConfigoptionalIResolvableOpenIdConnectConfigoptionalIResolvableOpenIdConnectConfigoptionalinterface{}#The OpenID Connect configuration.
ownerContactoptionalstringowner_contactoptionalstrownerContactoptionalStringOwnerContactoptionalstringOwnerContactoptional*string#The owner contact information for an API resource.
This field accepts any string input with a length of 0 - 256 characters.
queryDepthLimitoptionalnumberquery_depth_limitoptionalint | floatqueryDepthLimitoptionalNumberQueryDepthLimitoptionaldoubleQueryDepthLimitoptional*float64#The maximum depth a query can have in a single request.
notes
Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between 1 and 75 nested 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.
resolverCountLimitoptionalnumberresolver_count_limitoptionalint | floatresolverCountLimitoptionalNumberResolverCountLimitoptionaldoubleResolverCountLimitoptional*float64#The maximum number of resolvers that can be invoked in a single request.
The default value is 0 (or unspecified), which will set the limit to 10000 . When specified, the limit value can be between 1 and 10000 . This field will produce a limit error if the operation falls out of bounds.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#An arbitrary set of tags (key-value pairs) for this GraphQL API.
userPoolConfigoptionalIResolvable | CfnGraphQLApi.UserPoolConfigPropertyuser_pool_configoptionaltyping.Union[IResolvable, UserPoolConfigProperty]userPoolConfigoptionalIResolvableUserPoolConfigoptionalIResolvableUserPoolConfigoptionalinterface{}#Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
visibilityoptionalstringvisibilityoptionalstrvisibilityoptionalStringVisibilityoptionalstringVisibilityoptional*string#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.
WARNING : If Visibility has not been defined, explicitly setting it to GLOBAL in a template/stack update will result in an API replacement and new DNS values.
xrayEnabledoptionalboolean | IResolvablexray_enabledoptionaltyping.Union[bool, IResolvable]xrayEnabledoptionalBooleanXrayEnabledoptionalboolXrayEnabledoptionalinterface{}#A flag indicating whether to use AWS X-Ray tracing for this `GraphqlApi` .
Properties
additionalAuthenticationProvidersmay be undefinedIResolvable | IResolvable | CfnGraphQLApi.AdditionalAuthenticationProviderProperty[]additional_authentication_providersmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AdditionalAuthenticationProviderProperty]]]additionalAuthenticationProvidersmay be undefinedIResolvableAdditionalAuthenticationProvidersmay be undefinedIResolvableAdditionalAuthenticationProvidersmay be undefinedinterface{}#A list of additional authentication providers for the `GraphqlApi` API.
apiTypemay be undefinedstringapi_typemay be undefinedstrapiTypemay be undefinedStringApiTypemay be undefinedstringApiTypemay be undefined*string#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 as `arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid` .
attrGraphQlDnsstringattr_graph_ql_dnsstrattrGraphQlDnsStringAttrGraphQlDnsstringAttrGraphQlDns*string#The fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API.
attrGraphQlEndpointArnstringattr_graph_ql_endpoint_arnstrattrGraphQlEndpointArnStringAttrGraphQlEndpointArnstringAttrGraphQlEndpointArn*string#The GraphQL endpoint ARN.
attrGraphQlUrlstringattr_graph_ql_urlstrattrGraphQlUrlStringAttrGraphQlUrlstringAttrGraphQlUrl*string#The Endpoint URL of your GraphQL API.
attrRealtimeDnsstringattr_realtime_dnsstrattrRealtimeDnsStringAttrRealtimeDnsstringAttrRealtimeDns*string#The fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL API.
attrRealtimeUrlstringattr_realtime_urlstrattrRealtimeUrlStringAttrRealtimeUrlstringAttrRealtimeUrl*string#The GraphQL API real-time endpoint URL.
For more information, see Discovering the real-time endpoint from the GraphQL endpoint .
authenticationTypestringauthentication_typestrauthenticationTypeStringAuthenticationTypestringAuthenticationType*string#Security configuration for your GraphQL API.
CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringstatic#The CloudFormation resource type name for this resource class.
cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptions#Options for this resource, such as condition, update policy etc.
cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*string#AWS resource type.
creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*string#enhancedMetricsConfigmay be undefinedIResolvable | CfnGraphQLApi.EnhancedMetricsConfigPropertyenhanced_metrics_configmay be undefinedtyping.Union[IResolvable, EnhancedMetricsConfigProperty]enhancedMetricsConfigmay be undefinedIResolvableEnhancedMetricsConfigmay be undefinedIResolvableEnhancedMetricsConfigmay be undefinedinterface{}#Enables and controls the enhanced metrics feature.
environmentVariablesmay be undefinedIResolvable | { [key: string]: string }environment_variablesmay be undefinedtyping.Union[IResolvable, typing.Mapping[str, str]]environmentVariablesmay be undefinedIResolvableEnvironmentVariablesmay be undefinedIResolvableEnvironmentVariablesmay be undefinedinterface{}#A map containing the list of resources with their properties and environment variables.
graphQlApiRefGraphQLApiReferencegraph_ql_api_refGraphQLApiReferencegraphQlApiRefGraphQLApiReferenceGraphQlApiRefGraphQLApiReferenceGraphQlApiRefGraphQLApiReference#A reference to a GraphQLApi resource.
introspectionConfigmay be undefinedstringintrospection_configmay be undefinedstrintrospectionConfigmay be undefinedStringIntrospectionConfigmay be undefinedstringIntrospectionConfigmay be undefined*string#Sets the value of the GraphQL API to enable ( `ENABLED` ) or disable ( `DISABLED` ) introspection.
lambdaAuthorizerConfigmay be undefinedIResolvable | CfnGraphQLApi.LambdaAuthorizerConfigPropertylambda_authorizer_configmay be undefinedtyping.Union[IResolvable, LambdaAuthorizerConfigProperty]lambdaAuthorizerConfigmay be undefinedIResolvableLambdaAuthorizerConfigmay be undefinedIResolvableLambdaAuthorizerConfigmay be undefinedinterface{}#A `LambdaAuthorizerConfig` holds configuration on how to authorize AWS AppSync API access when using the `AWS_LAMBDA` authorizer mode.
logConfigmay be undefinedIResolvable | CfnGraphQLApi.LogConfigPropertylog_configmay be undefinedtyping.Union[IResolvable, LogConfigProperty]logConfigmay be undefinedIResolvableLogConfigmay be undefinedIResolvableLogConfigmay be undefinedinterface{}#The Amazon CloudWatch Logs configuration.
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).
mergedApiExecutionRoleArnmay be undefinedstringmerged_api_execution_role_arnmay be undefinedstrmergedApiExecutionRoleArnmay be undefinedStringMergedApiExecutionRoleArnmay be undefinedstringMergedApiExecutionRoleArnmay be undefined*string#The AWS Identity and Access Management service role ARN for a merged API.
The API name.
openIdConnectConfigmay be undefinedIResolvable | CfnGraphQLApi.OpenIDConnectConfigPropertyopen_id_connect_configmay be undefinedtyping.Union[IResolvable, OpenIDConnectConfigProperty]openIdConnectConfigmay be undefinedIResolvableOpenIdConnectConfigmay be undefinedIResolvableOpenIdConnectConfigmay be undefinedinterface{}#The OpenID Connect configuration.
ownerContactmay be undefinedstringowner_contactmay be undefinedstrownerContactmay be undefinedStringOwnerContactmay be undefinedstringOwnerContactmay be undefined*string#The owner contact information for an API resource.
queryDepthLimitmay be undefinednumberquery_depth_limitmay be undefinedint | floatqueryDepthLimitmay be undefinedNumberQueryDepthLimitmay be undefineddoubleQueryDepthLimitmay be undefined*float64#The maximum depth a query can have in a single request.
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 }).
resolverCountLimitmay be undefinednumberresolver_count_limitmay be undefinedint | floatresolverCountLimitmay be undefinedNumberResolverCountLimitmay be undefineddoubleResolverCountLimitmay be undefined*float64#The maximum number of resolvers that can be invoked in a single request.
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
Tag Manager which manages the tags for this resource.
tagsRawmay be undefinedCfnTag[]tags_rawmay be undefinedtyping.List[CfnTag]tagsRawmay be undefinedList<CfnTag>TagsRawmay be undefinedCfnTag[]TagsRawmay be undefined*[]CfnTag#An arbitrary set of tags (key-value pairs) for this GraphQL API.
userPoolConfigmay be undefinedIResolvable | CfnGraphQLApi.UserPoolConfigPropertyuser_pool_configmay be undefinedtyping.Union[IResolvable, UserPoolConfigProperty]userPoolConfigmay be undefinedIResolvableUserPoolConfigmay be undefinedIResolvableUserPoolConfigmay be undefinedinterface{}#Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
visibilitymay be undefinedstringvisibilitymay be undefinedstrvisibilitymay be undefinedStringVisibilitymay be undefinedstringVisibilitymay be undefined*string#Sets the scope of the GraphQL API to public ( `GLOBAL` ) or private ( `PRIVATE` ).
xrayEnabledmay be undefinedboolean | IResolvablexray_enabledmay be undefinedtyping.Union[bool, IResolvable]xrayEnabledmay be undefinedBooleanXrayEnabledmay be undefinedboolXrayEnabledmay be undefinedinterface{}#A flag indicating whether to use AWS X-Ray tracing for this `GraphqlApi` .
Methods
addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#Syntactic sugar for `addOverride(path, undefined)`.
1 parameter
Parameters
pathpathpathpathPath— The path of the value to delete.
addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#Use `addResourceDependency` instead.
This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.
addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#Use `addResourceDependency` instead.
notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.
addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#Add a value to the CloudFormation Resource Metadata.
addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#Adds an override to the synthesized CloudFormation resource.
notes · 2 parameters
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,
typescript
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
json
"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.
Parameters
pathpathpathpathPath— - The path of the property, you can use dot notation to override values in complex types.valuevaluevaluevalueValue— - The value.
addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#Adds an override that deletes the value of a property from the resource definition.
1 parameter
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path to the property.
addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value).
2 parameters
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path of the property.valuevaluevaluevalueValue— The value.
addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Sets the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
1 parameter
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#Sets the deletion policy of the resource based on the removal policy specified.
notes
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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:
arnForGraphQLApi(resource: IGraphQLApiRef): string@staticmethod def arn_for_graph_ql_api(resource: IGraphQLApiRef) -> strpublic static String arnForGraphQLApi(IGraphQLApiRef resource)public static string ArnForGraphQLApi(IGraphQLApiRef resource)func ArnForGraphQLApi(Resource IGraphQLApiRef) *stringstatic#cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#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.
1 parameter
Parameters
attributeNameattribute_nameattributeNameattributeNameAttributeName— The name of the attribute.
getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#Examines the CloudFormation resource and discloses attributes.
1 parameter
Parameters
inspectorinspectorinspectorinspectorInspector— tree inspector to collect and process attributes.
isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.
returns
Returns: The construct as a stack element or undefined if it is not a stack element.
isCfnGraphQLApi(x: any): boolean@staticmethod def is_cfn_graph_ql_api(x: Any) -> boolpublic static Boolean isCfnGraphQLApi(Object x)public static bool IsCfnGraphQLApi(object x)func IsCfnGraphQLApi(X interface{}) *boolstatic#Checks whether the given object is a CfnGraphQLApi.
isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#Check whether the given object is a CfnResource.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#Retrieves an array of resources and stacks this resource depends on.
For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.
overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#Overrides the auto-generated logical ID with a specific ID.
1 parameter
Parameters
newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId— The new logical ID to use for this stack element.
removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#Use `removeResourceDependency` instead
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#Replaces one dependency with another.
2 parameters
Parameters
targettargettargettargetTarget— The dependency to replace.newTargetnew_targetnewTargetnewTargetNewTarget— The new dependency to add.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
returns
Returns: a string representation of this resource
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.