Package com.pulumi.aws.apigateway

Class UsagePlan

  • public class UsagePlan
extends com.pulumi.resources.CustomResource
    Provides an API Gateway Usage Plan. ## Import Using `pulumi import`, import AWS API Gateway Usage Plan using the `id`. For example: ```sh $ pulumi import aws:apigateway/usagePlan:UsagePlan myusageplan <usage_plan_id> ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      UsagePlan​(java.lang.String name)  
      UsagePlan​(java.lang.String name, UsagePlanArgs args)  
      UsagePlan​(java.lang.String name, UsagePlanArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.util.List<UsagePlanApiStage>>> apiStages()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static UsagePlan get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, UsagePlanState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> productCode()  
      com.pulumi.core.Output<java.util.Optional<UsagePlanQuotaSettings>> quotaSettings()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.util.Optional<UsagePlanThrottleSettings>> throttleSettings()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • UsagePlan

        public UsagePlan​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • UsagePlan

        public UsagePlan​(java.lang.String name,
                 @Nullable
                 UsagePlanArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • UsagePlan

        public UsagePlan​(java.lang.String name,
                 @Nullable
                 UsagePlanArgs args,
                 @Nullable
                 com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • apiStages

        public com.pulumi.core.Output<java.util.Optional<java.util.List<UsagePlanApiStage>>> apiStages()
        Returns:
        Associated API stages of the usage plan. See `apiStages` Block below.

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the usage plan.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description of a usage plan.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the usage plan.

      • productCode

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> productCode()
        Returns:
        AWS Marketplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

      • quotaSettings

        public com.pulumi.core.Output<java.util.Optional<UsagePlanQuotaSettings>> quotaSettings()
        Returns:
        Quota settings of the usage plan. See `quotaSettings` Block below.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • throttleSettings

        public com.pulumi.core.Output<java.util.Optional<UsagePlanThrottleSettings>> throttleSettings()
        Returns:
        Throttling limits of the usage plan. See `throttleSettings` Block below.

      • get

        public static UsagePlan get​(java.lang.String name,
                            com.pulumi.core.Output<java.lang.String> id,
                            @Nullable
                            UsagePlanState state,
                            @Nullable
                            com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.