Class CfnApiKey

A CloudFormation AWS::ApiGateway::ApiKey.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnApiKey
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.AWS.APIGateway.dll
Syntax (csharp)
public class CfnApiKey : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnApiKey
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html

CloudformationResource: AWS::ApiGateway::ApiKey

Synopsis

Constructors

CfnApiKey(Construct, String, ICfnApiKeyProps)

Create a new AWS::ApiGateway::ApiKey.
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

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
CustomerId

AWS::ApiGateway::ApiKey.CustomerId.
Description

AWS::ApiGateway::ApiKey.Description.
Enabled

AWS::ApiGateway::ApiKey.Enabled.
GenerateDistinctId

AWS::ApiGateway::ApiKey.GenerateDistinctId.
Name

AWS::ApiGateway::ApiKey.Name.
StageKeys

AWS::ApiGateway::ApiKey.StageKeys.
Tags

AWS::ApiGateway::ApiKey.Tags.
Value

AWS::ApiGateway::ApiKey.Value.

Methods

Inspect(TreeInspector)

(experimental) Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnApiKey(Construct, String, ICfnApiKeyProps)

Create a new AWS::ApiGateway::ApiKey.

public CfnApiKey(Construct scope, string id, ICfnApiKeyProps props = null)
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

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

CustomerId

AWS::ApiGateway::ApiKey.CustomerId.

public virtual string CustomerId { get; set; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-customerid

Description

AWS::ApiGateway::ApiKey.Description.

public virtual string Description { get; set; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-description

Enabled

AWS::ApiGateway::ApiKey.Enabled.

public virtual object Enabled { get; set; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-enabled

GenerateDistinctId

AWS::ApiGateway::ApiKey.GenerateDistinctId.

public virtual object GenerateDistinctId { get; set; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-generatedistinctid

Name

AWS::ApiGateway::ApiKey.Name.

public virtual string Name { get; set; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-name

StageKeys

AWS::ApiGateway::ApiKey.StageKeys.

public virtual object StageKeys { get; set; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-stagekeys

Tags

AWS::ApiGateway::ApiKey.Tags.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-tags

Value

AWS::ApiGateway::ApiKey.Value.

public virtual string Value { get; set; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-value

Methods

Inspect(TreeInspector)

(experimental) Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector
  • tree inspector to collect and process attributes.
Remarks

Stability: Experimental

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>

Overrides

Implements

Constructs.IConstruct