Class CfnApiKey
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.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnApiKey : CfnResource, IInspectable
Syntax (vb)
Public Class CfnApiKey
Inherits CfnResource
Implements IInspectable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html
CloudformationResource: AWS::AppSync::ApiKey
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
Description = "description",
Expires = 123
});
Synopsis
Constructors
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 |
CfnApiKey(Construct, String, ICfnApiKeyProps) |
Properties
ApiId | Unique AWS AppSync GraphQL API ID for this API key. |
AttrApiKey | The API key. |
AttrApiKeyId | The API key ID. |
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(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
CfnApiKey(Construct, String, ICfnApiKeyProps)
public CfnApiKey(Construct scope, string id, ICfnApiKeyProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnApiKeyProps
Resource properties.
Properties
ApiId
Unique AWS AppSync GraphQL API ID for this API key.
public virtual string ApiId { get; set; }
Property Value
System.String
AttrApiKey
The API key.
public virtual string AttrApiKey { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ApiKey
AttrApiKeyId
The API key ID.
public virtual string AttrApiKeyId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ApiKeyId
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
Expires
The time after which the API key expires.
public virtual Nullable<double> Expires { get; set; }
Property Value
System.Nullable<System.Double>
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>