Interface ICfnGraphQLApiProps
Properties for defining a CfnGraphQLApi
.
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.AWS.AppSync.dll
Syntax (csharp)
public interface ICfnGraphQLApiProps
Syntax (vb)
Public Interface ICfnGraphQLApiProps
Remarks
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html
ExampleMetadata: fixture=_generated
Examples
// 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 cfnGraphQLApiProps = 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",
LambdaAuthorizerConfig = new LambdaAuthorizerConfigProperty {
AuthorizerResultTtlInSeconds = 123,
AuthorizerUri = "authorizerUri",
IdentityValidationExpression = "identityValidationExpression"
},
LogConfig = new LogConfigProperty {
CloudWatchLogsRoleArn = "cloudWatchLogsRoleArn",
ExcludeVerboseContent = false,
FieldLogLevel = "fieldLogLevel"
},
MergedApiExecutionRoleArn = "mergedApiExecutionRoleArn",
OpenIdConnectConfig = new OpenIDConnectConfigProperty {
AuthTtl = 123,
ClientId = "clientId",
IatTtl = 123,
Issuer = "issuer"
},
OwnerContact = "ownerContact",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
UserPoolConfig = new UserPoolConfigProperty {
AppIdClientRegex = "appIdClientRegex",
AwsRegion = "awsRegion",
DefaultAction = "defaultAction",
UserPoolId = "userPoolId"
},
Visibility = "visibility",
XrayEnabled = false
};
Synopsis
Properties
AdditionalAuthenticationProviders | A list of additional authentication providers for the |
ApiType | The value that indicates whether the GraphQL API is a standard API ( |
AuthenticationType | Security configuration for your GraphQL API. |
LambdaAuthorizerConfig | A |
LogConfig | The Amazon CloudWatch Logs configuration. |
MergedApiExecutionRoleArn | The AWS Identity and Access Management service role ARN for a merged API. |
Name | The API name. |
OpenIdConnectConfig | The OpenID Connect configuration. |
OwnerContact | The owner contact information for an API resource. |
Tags | An arbitrary set of tags (key-value pairs) for this GraphQL API. |
UserPoolConfig | Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint. |
Visibility | Sets the scope of the GraphQL API to public ( |
XrayEnabled | A flag indicating whether to use AWS X-Ray tracing for this |
Properties
AdditionalAuthenticationProviders
A list of additional authentication providers for the GraphqlApi
API.
virtual object AdditionalAuthenticationProviders { get; }
Property Value
System.Object
Remarks
ApiType
The value that indicates whether the GraphQL API is a standard API ( GRAPHQL
) or merged API ( MERGED
).
virtual string ApiType { get; }
Property Value
System.String
Remarks
The following values are valid:
GRAPHQL | MERGED
AuthenticationType
Security configuration for your GraphQL API.
string AuthenticationType { get; }
Property Value
System.String
Remarks
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 .
LambdaAuthorizerConfig
A LambdaAuthorizerConfig
holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA
authorizer mode.
virtual object LambdaAuthorizerConfig { get; }
Property Value
System.Object
Remarks
Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.
LogConfig
The Amazon CloudWatch Logs configuration.
virtual object LogConfig { get; }
Property Value
System.Object
Remarks
MergedApiExecutionRoleArn
The AWS Identity and Access Management service role ARN for a merged API.
virtual string MergedApiExecutionRoleArn { get; }
Property Value
System.String
Remarks
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.
Name
The API name.
string Name { get; }
Property Value
System.String
Remarks
OpenIdConnectConfig
The OpenID Connect configuration.
virtual object OpenIdConnectConfig { get; }
Property Value
System.Object
Remarks
OwnerContact
The owner contact information for an API resource.
virtual string OwnerContact { get; }
Property Value
System.String
Remarks
This field accepts any string input with a length of 0 - 256 characters.
Tags
An arbitrary set of tags (key-value pairs) for this GraphQL API.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
UserPoolConfig
Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
virtual object UserPoolConfig { get; }
Property Value
System.Object
Remarks
Visibility
Sets the scope of the GraphQL API to public ( GLOBAL
) or private ( PRIVATE
).
virtual string Visibility { get; }
Property Value
System.String
Remarks
By default, the scope is set to Global
if no value is provided.
XrayEnabled
A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi
.
virtual object XrayEnabled { get; }
Property Value
System.Object