Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. apigateway
  5. UsagePlanKey

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigateway.UsagePlanKey

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
pulumi/pulumi-aws-native

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

    Create UsagePlanKey Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new UsagePlanKey(name: string, args: UsagePlanKeyArgs, opts?: CustomResourceOptions);
    @overload
def UsagePlanKey(resource_name: str,
                 args: UsagePlanKeyArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def UsagePlanKey(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 key_id: Optional[str] = None,
                 key_type: Optional[UsagePlanKeyKeyType] = None,
                 usage_plan_id: Optional[str] = None)
    func NewUsagePlanKey(ctx *Context, name string, args UsagePlanKeyArgs, opts ...ResourceOption) (*UsagePlanKey, error)
    public UsagePlanKey(string name, UsagePlanKeyArgs args, CustomResourceOptions? opts = null)
    public UsagePlanKey(String name, UsagePlanKeyArgs args)
public UsagePlanKey(String name, UsagePlanKeyArgs args, CustomResourceOptions options)

    type: aws-native:apigateway:UsagePlanKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args UsagePlanKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UsagePlanKeyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UsagePlanKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UsagePlanKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UsagePlanKeyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const usagePlanKeyResource = new aws_native.apigateway.UsagePlanKey("usagePlanKeyResource", {
    keyId: "string",
    keyType: aws_native.apigateway.UsagePlanKeyKeyType.ApiKey,
    usagePlanId: "string",
});

    Coming soon!

    UsagePlanKey Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The UsagePlanKey resource accepts the following input properties:

    KeyId string
    The Id of the UsagePlanKey resource.
    KeyType Pulumi.AwsNative.ApiGateway.UsagePlanKeyKeyType
    The type of a UsagePlanKey resource for a plan customer.
    UsagePlanId string
    The Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.
    KeyId string
    The Id of the UsagePlanKey resource.
    KeyType UsagePlanKeyKeyType
    The type of a UsagePlanKey resource for a plan customer.
    UsagePlanId string
    The Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.
    keyId String
    The Id of the UsagePlanKey resource.
    keyType UsagePlanKeyKeyType
    The type of a UsagePlanKey resource for a plan customer.
    usagePlanId String
    The Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.
    keyId string
    The Id of the UsagePlanKey resource.
    keyType UsagePlanKeyKeyType
    The type of a UsagePlanKey resource for a plan customer.
    usagePlanId string
    The Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.
    key_id str
    The Id of the UsagePlanKey resource.
    key_type UsagePlanKeyKeyType
    The type of a UsagePlanKey resource for a plan customer.
    usage_plan_id str
    The Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.
    keyId String
    The Id of the UsagePlanKey resource.
    keyType "API_KEY"
    The type of a UsagePlanKey resource for a plan customer.
    usagePlanId String
    The Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the UsagePlanKey resource produces the following output properties:

    AwsId string
    Id string
    The provider-assigned unique ID for this managed resource.
    AwsId string
    Id string
    The provider-assigned unique ID for this managed resource.
    awsId String
    id String
    The provider-assigned unique ID for this managed resource.
    awsId string
    id string
    The provider-assigned unique ID for this managed resource.
    aws_id str
    id str
    The provider-assigned unique ID for this managed resource.
    awsId String
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    UsagePlanKeyKeyType, UsagePlanKeyKeyTypeArgs

    ApiKey
    API_KEY
    UsagePlanKeyKeyTypeApiKey
    API_KEY
    ApiKey
    API_KEY
    ApiKey
    API_KEY
    API_KEY
    API_KEY
    "API_KEY"
    API_KEY

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
    pulumi/pulumi-aws-native