Package software.amazon.awscdk.services.apigateway

Class CfnUsagePlanKey

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.apigateway.CfnUsagePlanKey
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:44.917Z") @Stability(Stable) public class CfnUsagePlanKey extends CfnResource implements IInspectable
A CloudFormation AWS::ApiGateway::UsagePlanKey.

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

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 CfnUsagePlanKey cfnUsagePlanKey = CfnUsagePlanKey.Builder.create(this, "MyCfnUsagePlanKey")
         .keyId("keyId")
         .keyType("keyType")
         .usagePlanId("usagePlanId")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnUsagePlanKey

      protected CfnUsagePlanKey(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnUsagePlanKey

      protected CfnUsagePlanKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnUsagePlanKey

      @Stability(Stable) public CfnUsagePlanKey(@NotNull Construct scope, @NotNull String id, @NotNull CfnUsagePlanKeyProps props)
      Create a new AWS::ApiGateway::UsagePlanKey.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID for the usage plan key.

      For example: abc123 .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getKeyId

      @Stability(Stable) @NotNull public String getKeyId()
      The Id of the UsagePlanKey resource to be deleted.

    • setKeyId

      @Stability(Stable) public void setKeyId(@NotNull String value)
      The Id of the UsagePlanKey resource to be deleted.

    • getKeyType

      @Stability(Stable) @NotNull public String getKeyType()
      The type of a UsagePlanKey resource for a plan customer.

    • setKeyType

      @Stability(Stable) public void setKeyType(@NotNull String value)
      The type of a UsagePlanKey resource for a plan customer.

    • getUsagePlanId

      @Stability(Stable) @NotNull public String getUsagePlanId()
      The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.

    • setUsagePlanId

      @Stability(Stable) public void setUsagePlanId(@NotNull String value)
      The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.