aws-sdk-pricingplanmanager 1.0.0

AWS SDK for PricingPlanManager
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct CreateSubscriptionInput {
    /// <p>The pricing plan family to subscribe to, such as <code>CloudFront</code>.</p>
    pub plan_family: ::std::option::Option<::std::string::String>,
    /// <p>The tier level for the subscription, such as <code>FREE</code>, <code>PRO</code>, <code>BUSINESS</code>, or <code>PREMIUM</code>.</p>
    pub plan_tier: ::std::option::Option<::std::string::String>,
    /// <p>The usage level within the plan tier. Specify <code>DEFAULT</code> for the base configuration, or a higher level if your plan tier supports it.</p>
    pub usage_level: ::std::option::Option<::std::string::String>,
    /// <p>The ARNs of the AWS resources to include in the subscription. Specify one or more supported resources.</p><note>
    /// <p>For subscriptions in the CloudFront plan family, the resources must include exactly one Amazon CloudFront distribution and exactly one AWS WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones and CloudFront KeyValueStores.</p>
    /// </note>
    pub resource_arns: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>Determines whether the subscription requires explicit approval before billing starts. Set to <code>MANUAL</code> to require a separate <code>ApprovePaidSubscription</code> call, or <code>IMMEDIATE</code> to activate the subscription right away. Defaults to <code>IMMEDIATE</code> if not specified.</p>
    pub approval_mode: ::std::option::Option<crate::types::ApprovalMode>,
    /// <p>A unique, case-sensitive identifier that you provide to ensure that the request is handled only once. If you send the same request with the same client token, the API returns the original response without creating a duplicate subscription.</p>
    pub client_token: ::std::option::Option<::std::string::String>,
}
impl CreateSubscriptionInput {
    /// <p>The pricing plan family to subscribe to, such as <code>CloudFront</code>.</p>
    pub fn plan_family(&self) -> ::std::option::Option<&str> {
        self.plan_family.as_deref()
    }
    /// <p>The tier level for the subscription, such as <code>FREE</code>, <code>PRO</code>, <code>BUSINESS</code>, or <code>PREMIUM</code>.</p>
    pub fn plan_tier(&self) -> ::std::option::Option<&str> {
        self.plan_tier.as_deref()
    }
    /// <p>The usage level within the plan tier. Specify <code>DEFAULT</code> for the base configuration, or a higher level if your plan tier supports it.</p>
    pub fn usage_level(&self) -> ::std::option::Option<&str> {
        self.usage_level.as_deref()
    }
    /// <p>The ARNs of the AWS resources to include in the subscription. Specify one or more supported resources.</p><note>
    /// <p>For subscriptions in the CloudFront plan family, the resources must include exactly one Amazon CloudFront distribution and exactly one AWS WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones and CloudFront KeyValueStores.</p>
    /// </note>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.resource_arns.is_none()`.
    pub fn resource_arns(&self) -> &[::std::string::String] {
        self.resource_arns.as_deref().unwrap_or_default()
    }
    /// <p>Determines whether the subscription requires explicit approval before billing starts. Set to <code>MANUAL</code> to require a separate <code>ApprovePaidSubscription</code> call, or <code>IMMEDIATE</code> to activate the subscription right away. Defaults to <code>IMMEDIATE</code> if not specified.</p>
    pub fn approval_mode(&self) -> ::std::option::Option<&crate::types::ApprovalMode> {
        self.approval_mode.as_ref()
    }
    /// <p>A unique, case-sensitive identifier that you provide to ensure that the request is handled only once. If you send the same request with the same client token, the API returns the original response without creating a duplicate subscription.</p>
    pub fn client_token(&self) -> ::std::option::Option<&str> {
        self.client_token.as_deref()
    }
}
impl CreateSubscriptionInput {
    /// Creates a new builder-style object to manufacture [`CreateSubscriptionInput`](crate::operation::create_subscription::CreateSubscriptionInput).
    pub fn builder() -> crate::operation::create_subscription::builders::CreateSubscriptionInputBuilder {
        crate::operation::create_subscription::builders::CreateSubscriptionInputBuilder::default()
    }
}

/// A builder for [`CreateSubscriptionInput`](crate::operation::create_subscription::CreateSubscriptionInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreateSubscriptionInputBuilder {
    pub(crate) plan_family: ::std::option::Option<::std::string::String>,
    pub(crate) plan_tier: ::std::option::Option<::std::string::String>,
    pub(crate) usage_level: ::std::option::Option<::std::string::String>,
    pub(crate) resource_arns: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) approval_mode: ::std::option::Option<crate::types::ApprovalMode>,
    pub(crate) client_token: ::std::option::Option<::std::string::String>,
}
impl CreateSubscriptionInputBuilder {
    /// <p>The pricing plan family to subscribe to, such as <code>CloudFront</code>.</p>
    /// This field is required.
    pub fn plan_family(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.plan_family = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The pricing plan family to subscribe to, such as <code>CloudFront</code>.</p>
    pub fn set_plan_family(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.plan_family = input;
        self
    }
    /// <p>The pricing plan family to subscribe to, such as <code>CloudFront</code>.</p>
    pub fn get_plan_family(&self) -> &::std::option::Option<::std::string::String> {
        &self.plan_family
    }
    /// <p>The tier level for the subscription, such as <code>FREE</code>, <code>PRO</code>, <code>BUSINESS</code>, or <code>PREMIUM</code>.</p>
    /// This field is required.
    pub fn plan_tier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.plan_tier = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The tier level for the subscription, such as <code>FREE</code>, <code>PRO</code>, <code>BUSINESS</code>, or <code>PREMIUM</code>.</p>
    pub fn set_plan_tier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.plan_tier = input;
        self
    }
    /// <p>The tier level for the subscription, such as <code>FREE</code>, <code>PRO</code>, <code>BUSINESS</code>, or <code>PREMIUM</code>.</p>
    pub fn get_plan_tier(&self) -> &::std::option::Option<::std::string::String> {
        &self.plan_tier
    }
    /// <p>The usage level within the plan tier. Specify <code>DEFAULT</code> for the base configuration, or a higher level if your plan tier supports it.</p>
    pub fn usage_level(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.usage_level = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The usage level within the plan tier. Specify <code>DEFAULT</code> for the base configuration, or a higher level if your plan tier supports it.</p>
    pub fn set_usage_level(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.usage_level = input;
        self
    }
    /// <p>The usage level within the plan tier. Specify <code>DEFAULT</code> for the base configuration, or a higher level if your plan tier supports it.</p>
    pub fn get_usage_level(&self) -> &::std::option::Option<::std::string::String> {
        &self.usage_level
    }
    /// Appends an item to `resource_arns`.
    ///
    /// To override the contents of this collection use [`set_resource_arns`](Self::set_resource_arns).
    ///
    /// <p>The ARNs of the AWS resources to include in the subscription. Specify one or more supported resources.</p><note>
    /// <p>For subscriptions in the CloudFront plan family, the resources must include exactly one Amazon CloudFront distribution and exactly one AWS WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones and CloudFront KeyValueStores.</p>
    /// </note>
    pub fn resource_arns(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.resource_arns.unwrap_or_default();
        v.push(input.into());
        self.resource_arns = ::std::option::Option::Some(v);
        self
    }
    /// <p>The ARNs of the AWS resources to include in the subscription. Specify one or more supported resources.</p><note>
    /// <p>For subscriptions in the CloudFront plan family, the resources must include exactly one Amazon CloudFront distribution and exactly one AWS WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones and CloudFront KeyValueStores.</p>
    /// </note>
    pub fn set_resource_arns(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.resource_arns = input;
        self
    }
    /// <p>The ARNs of the AWS resources to include in the subscription. Specify one or more supported resources.</p><note>
    /// <p>For subscriptions in the CloudFront plan family, the resources must include exactly one Amazon CloudFront distribution and exactly one AWS WAF web ACL. You can also include other supported resources, such as Amazon Route 53 hosted zones and CloudFront KeyValueStores.</p>
    /// </note>
    pub fn get_resource_arns(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.resource_arns
    }
    /// <p>Determines whether the subscription requires explicit approval before billing starts. Set to <code>MANUAL</code> to require a separate <code>ApprovePaidSubscription</code> call, or <code>IMMEDIATE</code> to activate the subscription right away. Defaults to <code>IMMEDIATE</code> if not specified.</p>
    pub fn approval_mode(mut self, input: crate::types::ApprovalMode) -> Self {
        self.approval_mode = ::std::option::Option::Some(input);
        self
    }
    /// <p>Determines whether the subscription requires explicit approval before billing starts. Set to <code>MANUAL</code> to require a separate <code>ApprovePaidSubscription</code> call, or <code>IMMEDIATE</code> to activate the subscription right away. Defaults to <code>IMMEDIATE</code> if not specified.</p>
    pub fn set_approval_mode(mut self, input: ::std::option::Option<crate::types::ApprovalMode>) -> Self {
        self.approval_mode = input;
        self
    }
    /// <p>Determines whether the subscription requires explicit approval before billing starts. Set to <code>MANUAL</code> to require a separate <code>ApprovePaidSubscription</code> call, or <code>IMMEDIATE</code> to activate the subscription right away. Defaults to <code>IMMEDIATE</code> if not specified.</p>
    pub fn get_approval_mode(&self) -> &::std::option::Option<crate::types::ApprovalMode> {
        &self.approval_mode
    }
    /// <p>A unique, case-sensitive identifier that you provide to ensure that the request is handled only once. If you send the same request with the same client token, the API returns the original response without creating a duplicate subscription.</p>
    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.client_token = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A unique, case-sensitive identifier that you provide to ensure that the request is handled only once. If you send the same request with the same client token, the API returns the original response without creating a duplicate subscription.</p>
    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.client_token = input;
        self
    }
    /// <p>A unique, case-sensitive identifier that you provide to ensure that the request is handled only once. If you send the same request with the same client token, the API returns the original response without creating a duplicate subscription.</p>
    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.client_token
    }
    /// Consumes the builder and constructs a [`CreateSubscriptionInput`](crate::operation::create_subscription::CreateSubscriptionInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::create_subscription::CreateSubscriptionInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::create_subscription::CreateSubscriptionInput {
            plan_family: self.plan_family,
            plan_tier: self.plan_tier,
            usage_level: self.usage_level,
            resource_arns: self.resource_arns,
            approval_mode: self.approval_mode,
            client_token: self.client_token,
        })
    }
}