interface CfnApiProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.AppSync.CfnApiProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#CfnApiProps |
![]() | software.amazon.awscdk.services.appsync.CfnApiProps |
![]() | aws_cdk.aws_appsync.CfnApiProps |
![]() | aws-cdk-lib » aws_appsync » CfnApiProps |
Properties for defining a CfnApi
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html
Example
// 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 cfnApiProps: appsync.CfnApiProps = {
name: 'name',
// the properties below are optional
eventConfig: {
authProviders: [{
authType: 'authType',
// the properties below are optional
cognitoConfig: {
awsRegion: 'awsRegion',
userPoolId: 'userPoolId',
// the properties below are optional
appIdClientRegex: 'appIdClientRegex',
},
lambdaAuthorizerConfig: {
authorizerUri: 'authorizerUri',
// the properties below are optional
authorizerResultTtlInSeconds: 123,
identityValidationExpression: 'identityValidationExpression',
},
openIdConnectConfig: {
issuer: 'issuer',
// the properties below are optional
authTtl: 123,
clientId: 'clientId',
iatTtl: 123,
},
}],
connectionAuthModes: [{
authType: 'authType',
}],
defaultPublishAuthModes: [{
authType: 'authType',
}],
defaultSubscribeAuthModes: [{
authType: 'authType',
}],
// the properties below are optional
logConfig: {
cloudWatchLogsRoleArn: 'cloudWatchLogsRoleArn',
logLevel: 'logLevel',
},
},
ownerContact: 'ownerContact',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
Name | Type | Description |
---|---|---|
name | string | The name of the Api . |
event | IResolvable | Event | Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API. |
owner | string | The owner contact information for an API resource. |
tags? | Cfn [] | A set of tags (key-value pairs) for this API. |
name
Type:
string
The name of the Api
.
eventConfig?
Type:
IResolvable
|
Event
(optional)
Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.
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:
Cfn
[]
(optional)
A set of tags (key-value pairs) for this API.