Class CfnUsagePlanKey

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

A CloudFormation AWS::ApiGateway::UsagePlanKey.

public class CfnUsagePlanKey : CfnResource, IInspectable

Inheritance

object

CfnUsagePlanKey

Implements

IInspectable

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.APIGateway;

             var cfnUsagePlanKey = new CfnUsagePlanKey(this, "MyCfnUsagePlanKey", new CfnUsagePlanKeyProps {
                 KeyId = "keyId",
                 KeyType = "keyType",
                 UsagePlanId = "usagePlanId"
             });

Remarks

The AWS::ApiGateway::UsagePlanKey resource associates an API key with a usage plan. This association determines which users the usage plan is applied to.

CloudformationResource: AWS::ApiGateway::UsagePlanKey

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html

ExampleMetadata: fixture=_generated

Constructors

CfnUsagePlanKey(Construct, string, ICfnUsagePlanKeyProps)

Create a new AWS::ApiGateway::UsagePlanKey.

public CfnUsagePlanKey(Construct scope, string id, ICfnUsagePlanKeyProps props)

Parameters

scope Construct

• scope in which this resource is defined.

id string

• scoped id of the resource.

props ICfnUsagePlanKeyProps

• resource properties.

Properties

AttrId

The ID for the usage plan key.

public virtual string AttrId { get; }

Property Value

string

Remarks

For example: abc123 .

CloudformationAttribute: Id

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

KeyId

The Id of the UsagePlanKey resource to be deleted.

public virtual string KeyId { get; set; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-keyid

KeyType

The type of a UsagePlanKey resource for a plan customer.

public virtual string KeyType { get; set; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-keytype

UsagePlanId

The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.

public virtual string UsagePlanId { get; set; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-usageplanid

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 IDictionary<string, object>

Returns

IDictionary<string, object>