Struct aws_sdk_apigateway::output::CreateUsagePlanOutput

#[non_exhaustive]
pub struct CreateUsagePlanOutput {
    pub id: Option<String>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub api_stages: Option<Vec<ApiStage>>,
    pub throttle: Option<ThrottleSettings>,
    pub quota: Option<QuotaSettings>,
    pub product_code: Option<String>,
    pub tags: Option<HashMap<String, String>>,
}

Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using AWS Budgets to monitor costs and AWS WAF to manage API requests.

In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.

Create and Use Usage Plans

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: Option<String>

The identifier of a UsagePlan resource.

name: Option<String>

The name of a usage plan.

description: Option<String>

The description of a usage plan.

api_stages: Option<Vec<ApiStage>>

The associated API stages of a usage plan.

throttle: Option<ThrottleSettings>

Map containing method level throttling information for API stage in a usage plan.

quota: Option<QuotaSettings>

The target maximum number of permitted requests per a given unit time interval.

product_code: Option<String>

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

tags: Option<HashMap<String, String>>

The collection of tags. Each tag element is associated with a given resource.

Implementations

impl CreateUsagePlanOutput

pub fn id(&self) -> Option<&str>

The identifier of a UsagePlan resource.

pub fn name(&self) -> Option<&str>

The name of a usage plan.

pub fn description(&self) -> Option<&str>

The description of a usage plan.

pub fn api_stages(&self) -> Option<&[ApiStage]>

The associated API stages of a usage plan.

pub fn throttle(&self) -> Option<&ThrottleSettings>

Map containing method level throttling information for API stage in a usage plan.

pub fn quota(&self) -> Option<&QuotaSettings>

The target maximum number of permitted requests per a given unit time interval.

pub fn product_code(&self) -> Option<&str>

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

pub fn tags(&self) -> Option<&HashMap<String, String>>

The collection of tags. Each tag element is associated with a given resource.

impl CreateUsagePlanOutput

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateUsagePlanOutput

Trait Implementations

impl Clone for CreateUsagePlanOutput

fn clone(&self) -> CreateUsagePlanOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateUsagePlanOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<CreateUsagePlanOutput> for CreateUsagePlanOutput

fn eq(&self, other: &CreateUsagePlanOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CreateUsagePlanOutput) -> bool

This method tests for !=.

impl StructuralPartialEq for CreateUsagePlanOutput