Class CfnUsagePlanKey

A CloudFormation AWS::ApiGateway::UsagePlanKey.

Inheritance

System.Object

CfnElement

CfnRefElement

CfnResource

CfnUsagePlanKey

Implements

IInspectable

Inherited Members

CfnResource.IsCfnResource(IConstruct)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String, Nullable<ResolutionTypeHint>)

CfnResource.GetMetadata(String)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnUsagePlanKey : CfnResource, IInspectable

Syntax (vb)

Public Class CfnUsagePlanKey
    Inherits CfnResource
    Implements IInspectable

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

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"
});

Synopsis

Constructors

CfnUsagePlanKey(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnUsagePlanKey(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
CfnUsagePlanKey(Construct, String, ICfnUsagePlanKeyProps)	Create a new `AWS::ApiGateway::UsagePlanKey`.

Properties

AttrId	The ID for the usage plan key.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties
KeyId	The Id of the UsagePlanKey resource to be deleted.
KeyType	The type of a UsagePlanKey resource for a plan customer.
UsagePlanId	The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.

Methods

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

Constructors

CfnUsagePlanKey(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnUsagePlanKey(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

CfnUsagePlanKey(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnUsagePlanKey(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

CfnUsagePlanKey(Construct, String, ICfnUsagePlanKeyProps)

Create a new AWS::ApiGateway::UsagePlanKey.

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

Parameters

scope Constructs.Construct

scope in which this resource is defined.

id System.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

System.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

System.String

CfnProperties

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

Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.CfnProperties

KeyId

The Id of the UsagePlanKey resource to be deleted.

public virtual string KeyId { get; set; }

Property Value

System.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

System.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

System.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 System.Collections.Generic.IDictionary<System.String, System.Object>

Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IInspectable