Struct CreateUsagePlanInput

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

The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.

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.

name: Option<String>

The name of the usage plan.

description: Option<String>

The description of the usage plan.

api_stages: Option<Vec<ApiStage>>

The associated API stages of the usage plan.

throttle: Option<ThrottleSettings>

The throttling limits of the usage plan.

quota: Option<QuotaSettings>

The quota of the usage plan.

tags: Option<HashMap<String, String>>

The key-value map of strings. The valid character set is \[a-zA-Z+-=._:/\]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Implementations

impl CreateUsagePlanInput

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

The name of the usage plan.

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

The description of the usage plan.

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

The associated API stages of the usage plan.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .api_stages.is_none().

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

The throttling limits of the usage plan.

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

The quota of the usage plan.

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

The key-value map of strings. The valid character set is \[a-zA-Z+-=._:/\]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

impl CreateUsagePlanInput

pub fn builder() -> CreateUsagePlanInputBuilder

Creates a new builder-style object to manufacture CreateUsagePlanInput.

Trait Implementations

impl Clone for CreateUsagePlanInput

fn clone(&self) -> CreateUsagePlanInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateUsagePlanInput

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

Formats the value using the given formatter.

impl PartialEq for CreateUsagePlanInput

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateUsagePlanInput