Class CfnApiKey
A CloudFormation AWS::AppSync::ApiKey
.
Inherited Members
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.AWS.AppSync.dll
Syntax (csharp)
public class CfnApiKey : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnApiKey
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::AppSync::ApiKey
resource creates a unique key that you can distribute to clients who are executing GraphQL operations with AWS AppSync that require an API key.
CloudformationResource: AWS::AppSync::ApiKey
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.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 cfnApiKey = new CfnApiKey(this, "MyCfnApiKey", new CfnApiKeyProps {
ApiId = "apiId",
// the properties below are optional
ApiKeyId = "apiKeyId",
Description = "description",
Expires = 123
});
Synopsis
Constructors
CfnApiKey(Construct, String, ICfnApiKeyProps) | Create a new |
CfnApiKey(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnApiKey(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
ApiId | Unique AWS AppSync GraphQL API ID for this API key. |
ApiKeyId | The API key ID. |
AttrApiKey | The API key. |
AttrArn | The Amazon Resource Name (ARN) of the API key, such as |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | Unique description of your API key. |
Expires | The time after which the API key expires. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnApiKey(Construct, String, ICfnApiKeyProps)
Create a new AWS::AppSync::ApiKey
.
public CfnApiKey(Construct scope, string id, ICfnApiKeyProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnApiKeyProps
- resource properties.
CfnApiKey(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnApiKey(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnApiKey(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnApiKey(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
ApiId
Unique AWS AppSync GraphQL API ID for this API key.
public virtual string ApiId { get; set; }
Property Value
System.String
Remarks
ApiKeyId
The API key ID.
public virtual string ApiKeyId { get; set; }
Property Value
System.String
Remarks
AttrApiKey
The API key.
public virtual string AttrApiKey { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ApiKey
AttrArn
The Amazon Resource Name (ARN) of the API key, such as arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/apikey/apikeya1bzhi
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
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
Description
Unique description of your API key.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
Expires
The time after which the API key expires.
public virtual Nullable<double> Expires { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
The date is represented as seconds since the epoch, rounded down to the nearest hour.
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>