Struct aws_sdk_apigateway::client::fluent_builders::CreateUsagePlan

pub struct CreateUsagePlan<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to CreateUsagePlan.

Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.

Implementations

impl<C, M, R> CreateUsagePlan<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<CreateUsagePlanOutput, SdkError<CreateUsagePlanError>> where
    R::Policy: SmithyRetryPolicy<CreateUsagePlanInputOperationOutputAlias, CreateUsagePlanOutput, CreateUsagePlanError, CreateUsagePlanInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn name(self, input: impl Into<String>) -> Self

[Required] The name of the usage plan.

pub fn set_name(self, input: Option<String>) -> Self

[Required] The name of the usage plan.

pub fn description(self, input: impl Into<String>) -> Self

The description of the usage plan.

pub fn set_description(self, input: Option<String>) -> Self

The description of the usage plan.

pub fn api_stages(self, input: ApiStage) -> Self

Appends an item to apiStages.

To override the contents of this collection use set_api_stages.

The associated API stages of the usage plan.

pub fn set_api_stages(self, input: Option<Vec<ApiStage>>) -> Self

The associated API stages of the usage plan.

pub fn throttle(self, input: ThrottleSettings) -> Self

The throttling limits of the usage plan.

pub fn set_throttle(self, input: Option<ThrottleSettings>) -> Self

The throttling limits of the usage plan.

pub fn quota(self, input: QuotaSettings) -> Self

The quota of the usage plan.

pub fn set_quota(self, input: Option<QuotaSettings>) -> Self

The quota of the usage plan.

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

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.

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

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.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for CreateUsagePlan<C, M, R>

fn clone(&self) -> CreateUsagePlan<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for CreateUsagePlan<C, M, R>

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

Formats the value using the given formatter.