aws-sdk-computeoptimizerautomation 1.9.0

AWS SDK for Compute Optimizer Automation
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 CreateAutomationRuleInput {
    /// <p>The name of the automation rule.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>A description of the automation rule.</p>
    pub description: ::std::option::Option<::std::string::String>,
    /// <p>The type of rule.</p><note>
    /// <p>Only the management account or a delegated administrator can set the ruleType to be OrganizationRule.</p>
    /// </note>
    pub rule_type: ::std::option::Option<crate::types::RuleType>,
    /// <p>Configuration for organization-level rules. Required for OrganizationRule type.</p>
    pub organization_configuration: ::std::option::Option<crate::types::OrganizationConfiguration>,
    /// <p>A string representation of a decimal number between 0 and 1 (having up to 30 digits after the decimal point) that determines the priority of the rule. When multiple rules match the same recommended action, Compute Optimizer assigns the action to the rule with the lowest priority value (highest priority), even if that rule is scheduled to run later than other matching rules.</p>
    pub priority: ::std::option::Option<::std::string::String>,
    /// <p>The types of recommended actions this rule will automate.</p>
    pub recommended_action_types: ::std::option::Option<::std::vec::Vec<crate::types::RecommendedActionType>>,
    /// <p>A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time.</p>
    pub criteria: ::std::option::Option<crate::types::Criteria>,
    /// <p>The schedule for when the rule should run.</p>
    pub schedule: ::std::option::Option<crate::types::Schedule>,
    /// <p>The status of the rule</p>
    pub status: ::std::option::Option<crate::types::RuleStatus>,
    /// <p>The tags to associate with the rule.</p>
    pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
    /// <p>A unique identifier to ensure idempotency of the request.</p>
    pub client_token: ::std::option::Option<::std::string::String>,
}
impl CreateAutomationRuleInput {
    /// <p>The name of the automation rule.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>A description of the automation rule.</p>
    pub fn description(&self) -> ::std::option::Option<&str> {
        self.description.as_deref()
    }
    /// <p>The type of rule.</p><note>
    /// <p>Only the management account or a delegated administrator can set the ruleType to be OrganizationRule.</p>
    /// </note>
    pub fn rule_type(&self) -> ::std::option::Option<&crate::types::RuleType> {
        self.rule_type.as_ref()
    }
    /// <p>Configuration for organization-level rules. Required for OrganizationRule type.</p>
    pub fn organization_configuration(&self) -> ::std::option::Option<&crate::types::OrganizationConfiguration> {
        self.organization_configuration.as_ref()
    }
    /// <p>A string representation of a decimal number between 0 and 1 (having up to 30 digits after the decimal point) that determines the priority of the rule. When multiple rules match the same recommended action, Compute Optimizer assigns the action to the rule with the lowest priority value (highest priority), even if that rule is scheduled to run later than other matching rules.</p>
    pub fn priority(&self) -> ::std::option::Option<&str> {
        self.priority.as_deref()
    }
    /// <p>The types of recommended actions this rule will automate.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.recommended_action_types.is_none()`.
    pub fn recommended_action_types(&self) -> &[crate::types::RecommendedActionType] {
        self.recommended_action_types.as_deref().unwrap_or_default()
    }
    /// <p>A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time.</p>
    pub fn criteria(&self) -> ::std::option::Option<&crate::types::Criteria> {
        self.criteria.as_ref()
    }
    /// <p>The schedule for when the rule should run.</p>
    pub fn schedule(&self) -> ::std::option::Option<&crate::types::Schedule> {
        self.schedule.as_ref()
    }
    /// <p>The status of the rule</p>
    pub fn status(&self) -> ::std::option::Option<&crate::types::RuleStatus> {
        self.status.as_ref()
    }
    /// <p>The tags to associate with the rule.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.tags.is_none()`.
    pub fn tags(&self) -> &[crate::types::Tag] {
        self.tags.as_deref().unwrap_or_default()
    }
    /// <p>A unique identifier to ensure idempotency of the request.</p>
    pub fn client_token(&self) -> ::std::option::Option<&str> {
        self.client_token.as_deref()
    }
}
impl CreateAutomationRuleInput {
    /// Creates a new builder-style object to manufacture [`CreateAutomationRuleInput`](crate::operation::create_automation_rule::CreateAutomationRuleInput).
    pub fn builder() -> crate::operation::create_automation_rule::builders::CreateAutomationRuleInputBuilder {
        crate::operation::create_automation_rule::builders::CreateAutomationRuleInputBuilder::default()
    }
}

/// A builder for [`CreateAutomationRuleInput`](crate::operation::create_automation_rule::CreateAutomationRuleInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreateAutomationRuleInputBuilder {
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) description: ::std::option::Option<::std::string::String>,
    pub(crate) rule_type: ::std::option::Option<crate::types::RuleType>,
    pub(crate) organization_configuration: ::std::option::Option<crate::types::OrganizationConfiguration>,
    pub(crate) priority: ::std::option::Option<::std::string::String>,
    pub(crate) recommended_action_types: ::std::option::Option<::std::vec::Vec<crate::types::RecommendedActionType>>,
    pub(crate) criteria: ::std::option::Option<crate::types::Criteria>,
    pub(crate) schedule: ::std::option::Option<crate::types::Schedule>,
    pub(crate) status: ::std::option::Option<crate::types::RuleStatus>,
    pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
    pub(crate) client_token: ::std::option::Option<::std::string::String>,
}
impl CreateAutomationRuleInputBuilder {
    /// <p>The name of the automation rule.</p>
    /// This field is required.
    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the automation rule.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The name of the automation rule.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>A description of the automation rule.</p>
    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.description = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A description of the automation rule.</p>
    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.description = input;
        self
    }
    /// <p>A description of the automation rule.</p>
    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.description
    }
    /// <p>The type of rule.</p><note>
    /// <p>Only the management account or a delegated administrator can set the ruleType to be OrganizationRule.</p>
    /// </note>
    /// This field is required.
    pub fn rule_type(mut self, input: crate::types::RuleType) -> Self {
        self.rule_type = ::std::option::Option::Some(input);
        self
    }
    /// <p>The type of rule.</p><note>
    /// <p>Only the management account or a delegated administrator can set the ruleType to be OrganizationRule.</p>
    /// </note>
    pub fn set_rule_type(mut self, input: ::std::option::Option<crate::types::RuleType>) -> Self {
        self.rule_type = input;
        self
    }
    /// <p>The type of rule.</p><note>
    /// <p>Only the management account or a delegated administrator can set the ruleType to be OrganizationRule.</p>
    /// </note>
    pub fn get_rule_type(&self) -> &::std::option::Option<crate::types::RuleType> {
        &self.rule_type
    }
    /// <p>Configuration for organization-level rules. Required for OrganizationRule type.</p>
    pub fn organization_configuration(mut self, input: crate::types::OrganizationConfiguration) -> Self {
        self.organization_configuration = ::std::option::Option::Some(input);
        self
    }
    /// <p>Configuration for organization-level rules. Required for OrganizationRule type.</p>
    pub fn set_organization_configuration(mut self, input: ::std::option::Option<crate::types::OrganizationConfiguration>) -> Self {
        self.organization_configuration = input;
        self
    }
    /// <p>Configuration for organization-level rules. Required for OrganizationRule type.</p>
    pub fn get_organization_configuration(&self) -> &::std::option::Option<crate::types::OrganizationConfiguration> {
        &self.organization_configuration
    }
    /// <p>A string representation of a decimal number between 0 and 1 (having up to 30 digits after the decimal point) that determines the priority of the rule. When multiple rules match the same recommended action, Compute Optimizer assigns the action to the rule with the lowest priority value (highest priority), even if that rule is scheduled to run later than other matching rules.</p>
    pub fn priority(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.priority = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A string representation of a decimal number between 0 and 1 (having up to 30 digits after the decimal point) that determines the priority of the rule. When multiple rules match the same recommended action, Compute Optimizer assigns the action to the rule with the lowest priority value (highest priority), even if that rule is scheduled to run later than other matching rules.</p>
    pub fn set_priority(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.priority = input;
        self
    }
    /// <p>A string representation of a decimal number between 0 and 1 (having up to 30 digits after the decimal point) that determines the priority of the rule. When multiple rules match the same recommended action, Compute Optimizer assigns the action to the rule with the lowest priority value (highest priority), even if that rule is scheduled to run later than other matching rules.</p>
    pub fn get_priority(&self) -> &::std::option::Option<::std::string::String> {
        &self.priority
    }
    /// Appends an item to `recommended_action_types`.
    ///
    /// To override the contents of this collection use [`set_recommended_action_types`](Self::set_recommended_action_types).
    ///
    /// <p>The types of recommended actions this rule will automate.</p>
    pub fn recommended_action_types(mut self, input: crate::types::RecommendedActionType) -> Self {
        let mut v = self.recommended_action_types.unwrap_or_default();
        v.push(input);
        self.recommended_action_types = ::std::option::Option::Some(v);
        self
    }
    /// <p>The types of recommended actions this rule will automate.</p>
    pub fn set_recommended_action_types(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::RecommendedActionType>>) -> Self {
        self.recommended_action_types = input;
        self
    }
    /// <p>The types of recommended actions this rule will automate.</p>
    pub fn get_recommended_action_types(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::RecommendedActionType>> {
        &self.recommended_action_types
    }
    /// <p>A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time.</p>
    pub fn criteria(mut self, input: crate::types::Criteria) -> Self {
        self.criteria = ::std::option::Option::Some(input);
        self
    }
    /// <p>A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time.</p>
    pub fn set_criteria(mut self, input: ::std::option::Option<crate::types::Criteria>) -> Self {
        self.criteria = input;
        self
    }
    /// <p>A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time.</p>
    pub fn get_criteria(&self) -> &::std::option::Option<crate::types::Criteria> {
        &self.criteria
    }
    /// <p>The schedule for when the rule should run.</p>
    /// This field is required.
    pub fn schedule(mut self, input: crate::types::Schedule) -> Self {
        self.schedule = ::std::option::Option::Some(input);
        self
    }
    /// <p>The schedule for when the rule should run.</p>
    pub fn set_schedule(mut self, input: ::std::option::Option<crate::types::Schedule>) -> Self {
        self.schedule = input;
        self
    }
    /// <p>The schedule for when the rule should run.</p>
    pub fn get_schedule(&self) -> &::std::option::Option<crate::types::Schedule> {
        &self.schedule
    }
    /// <p>The status of the rule</p>
    /// This field is required.
    pub fn status(mut self, input: crate::types::RuleStatus) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The status of the rule</p>
    pub fn set_status(mut self, input: ::std::option::Option<crate::types::RuleStatus>) -> Self {
        self.status = input;
        self
    }
    /// <p>The status of the rule</p>
    pub fn get_status(&self) -> &::std::option::Option<crate::types::RuleStatus> {
        &self.status
    }
    /// Appends an item to `tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>The tags to associate with the rule.</p>
    pub fn tags(mut self, input: crate::types::Tag) -> Self {
        let mut v = self.tags.unwrap_or_default();
        v.push(input);
        self.tags = ::std::option::Option::Some(v);
        self
    }
    /// <p>The tags to associate with the rule.</p>
    pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
        self.tags = input;
        self
    }
    /// <p>The tags to associate with the rule.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
        &self.tags
    }
    /// <p>A unique identifier to ensure idempotency of the request.</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 identifier to ensure idempotency of the request.</p>
    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.client_token = input;
        self
    }
    /// <p>A unique identifier to ensure idempotency of the request.</p>
    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.client_token
    }
    /// Consumes the builder and constructs a [`CreateAutomationRuleInput`](crate::operation::create_automation_rule::CreateAutomationRuleInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::create_automation_rule::CreateAutomationRuleInput, ::aws_smithy_types::error::operation::BuildError>
    {
        ::std::result::Result::Ok(crate::operation::create_automation_rule::CreateAutomationRuleInput {
            name: self.name,
            description: self.description,
            rule_type: self.rule_type,
            organization_configuration: self.organization_configuration,
            priority: self.priority,
            recommended_action_types: self.recommended_action_types,
            criteria: self.criteria,
            schedule: self.schedule,
            status: self.status,
            tags: self.tags,
            client_token: self.client_token,
        })
    }
}