Class CfnGraphQLApi
A CloudFormation AWS::AppSync::GraphQLApi
.
Inherited Members
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.AWS.AppSync.dll
Syntax (csharp)
public class CfnGraphQLApi : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnGraphQLApi
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
CloudformationResource: AWS::AppSync::GraphQLApi
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 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",
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
Constructors
CfnGraphQLApi(Construct, String, ICfnGraphQLApiProps) | Create a new |
CfnGraphQLApi(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnGraphQLApi(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AdditionalAuthenticationProviders | A list of additional authentication providers for the |
ApiType | The value that indicates whether the GraphQL API is a standard API ( |
AttrApiId | Unique AWS AppSync GraphQL API identifier. |
AttrArn | The Amazon Resource Name (ARN) of the API key, such as |
AttrGraphQlDns | The fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API. |
AttrGraphQlUrl | The Endpoint URL of your GraphQL API. |
AttrRealtimeDns | The fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL API. |
AttrRealtimeUrl | The GraphQL API real-time endpoint URL. |
AuthenticationType | Security configuration for your GraphQL API. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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 |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnGraphQLApi(Construct, String, ICfnGraphQLApiProps)
Create a new AWS::AppSync::GraphQLApi
.
public CfnGraphQLApi(Construct scope, string id, ICfnGraphQLApiProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnGraphQLApiProps
- resource properties.
CfnGraphQLApi(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnGraphQLApi(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnGraphQLApi(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnGraphQLApi(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AdditionalAuthenticationProviders
A list of additional authentication providers for the GraphqlApi
API.
public virtual object AdditionalAuthenticationProviders { get; set; }
Property Value
System.Object
Remarks
ApiType
The value that indicates whether the GraphQL API is a standard API ( GRAPHQL
) or merged API ( MERGED
).
public virtual string ApiType { get; set; }
Property Value
System.String
Remarks
The following values are valid:
GRAPHQL | MERGED
AttrApiId
Unique AWS AppSync GraphQL API identifier.
public virtual string AttrApiId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ApiId
AttrArn
The Amazon Resource Name (ARN) of the API key, such as arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrGraphQlDns
The fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API.
public virtual string AttrGraphQlDns { get; }
Property Value
System.String
Remarks
CloudformationAttribute: GraphQLDns
AttrGraphQlUrl
The Endpoint URL of your GraphQL API.
public virtual string AttrGraphQlUrl { get; }
Property Value
System.String
Remarks
CloudformationAttribute: GraphQLUrl
AttrRealtimeDns
The fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL API.
public virtual string AttrRealtimeDns { get; }
Property Value
System.String
Remarks
CloudformationAttribute: RealtimeDns
AttrRealtimeUrl
The GraphQL API real-time endpoint URL.
public virtual string AttrRealtimeUrl { get; }
Property Value
System.String
Remarks
For more information, see Discovering the real-time endpoint from the GraphQL endpoint .
CloudformationAttribute: RealtimeUrl
AuthenticationType
Security configuration for your GraphQL API.
public virtual string AuthenticationType { get; set; }
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 .
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
LambdaAuthorizerConfig
A LambdaAuthorizerConfig
holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA
authorizer mode.
public virtual object LambdaAuthorizerConfig { get; set; }
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.
public virtual object LogConfig { get; set; }
Property Value
System.Object
Remarks
MergedApiExecutionRoleArn
The AWS Identity and Access Management service role ARN for a merged API.
public virtual string MergedApiExecutionRoleArn { get; set; }
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.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
OpenIdConnectConfig
The OpenID Connect configuration.
public virtual object OpenIdConnectConfig { get; set; }
Property Value
System.Object
Remarks
OwnerContact
The owner contact information for an API resource.
public virtual string OwnerContact { get; set; }
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.
public virtual TagManager Tags { get; }
Property Value
Remarks
UserPoolConfig
Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
public virtual object UserPoolConfig { get; set; }
Property Value
System.Object
Remarks
Visibility
Sets the scope of the GraphQL API to public ( GLOBAL
) or private ( PRIVATE
).
public virtual string Visibility { get; set; }
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
.
public virtual object XrayEnabled { get; set; }
Property Value
System.Object
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>