aws-sdk-computeoptimizerautomation 1.5.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 UpdateAutomationRuleInput {
    /// <p>The ARN of the rule to update.</p>
    pub rule_arn: ::std::option::Option<::std::string::String>,
    /// <p>The revision number of the rule to update.</p>
    pub rule_revision: ::std::option::Option<i64>,
    /// <p>The updated name of the automation rule. Must be 1-128 characters long and contain only alphanumeric characters, underscores, and hyphens.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>The updated description of the automation rule. Can be up to 1024 characters long and contain alphanumeric characters, underscores, hyphens, spaces, and certain special characters.</p>
    pub description: ::std::option::Option<::std::string::String>,
    /// <p>The updated type of automation rule. Can be either OrganizationRule for organization-wide rules or AccountRule for account-specific rules.</p>
    pub rule_type: ::std::option::Option<crate::types::RuleType>,
    /// <p>Updated configuration settings for organization-wide rules, including rule application order and target account IDs.</p>
    pub organization_configuration: ::std::option::Option<crate::types::OrganizationConfiguration>,
    /// <p>The updated priority level of the automation rule, used to determine execution order when multiple rules apply to the same resource.</p>
    pub priority: ::std::option::Option<::std::string::String>,
    /// <p>Updated list of recommended action types that this rule can execute, such as SnapshotAndDeleteUnattachedEbsVolume or UpgradeEbsVolumeType.</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. You can specify up to 20 conditions per filter criteria and 20 values per condition.</p>
    pub criteria: ::std::option::Option<crate::types::Criteria>,
    /// <p>The updated schedule configuration for when the automation rule should execute, including cron expression, timezone, and execution window.</p>
    pub schedule: ::std::option::Option<crate::types::Schedule>,
    /// <p>The updated status of the automation rule. Can be Active or Inactive.</p>
    pub status: ::std::option::Option<crate::types::RuleStatus>,
    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Must be 1-64 characters long and contain only alphanumeric characters, underscores, and hyphens.</p>
    pub client_token: ::std::option::Option<::std::string::String>,
}
impl UpdateAutomationRuleInput {
    /// <p>The ARN of the rule to update.</p>
    pub fn rule_arn(&self) -> ::std::option::Option<&str> {
        self.rule_arn.as_deref()
    }
    /// <p>The revision number of the rule to update.</p>
    pub fn rule_revision(&self) -> ::std::option::Option<i64> {
        self.rule_revision
    }
    /// <p>The updated name of the automation rule. Must be 1-128 characters long and contain only alphanumeric characters, underscores, and hyphens.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>The updated description of the automation rule. Can be up to 1024 characters long and contain alphanumeric characters, underscores, hyphens, spaces, and certain special characters.</p>
    pub fn description(&self) -> ::std::option::Option<&str> {
        self.description.as_deref()
    }
    /// <p>The updated type of automation rule. Can be either OrganizationRule for organization-wide rules or AccountRule for account-specific rules.</p>
    pub fn rule_type(&self) -> ::std::option::Option<&crate::types::RuleType> {
        self.rule_type.as_ref()
    }
    /// <p>Updated configuration settings for organization-wide rules, including rule application order and target account IDs.</p>
    pub fn organization_configuration(&self) -> ::std::option::Option<&crate::types::OrganizationConfiguration> {
        self.organization_configuration.as_ref()
    }
    /// <p>The updated priority level of the automation rule, used to determine execution order when multiple rules apply to the same resource.</p>
    pub fn priority(&self) -> ::std::option::Option<&str> {
        self.priority.as_deref()
    }
    /// <p>Updated list of recommended action types that this rule can execute, such as SnapshotAndDeleteUnattachedEbsVolume or UpgradeEbsVolumeType.</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. You can specify up to 20 conditions per filter criteria and 20 values per condition.</p>
    pub fn criteria(&self) -> ::std::option::Option<&crate::types::Criteria> {
        self.criteria.as_ref()
    }
    /// <p>The updated schedule configuration for when the automation rule should execute, including cron expression, timezone, and execution window.</p>
    pub fn schedule(&self) -> ::std::option::Option<&crate::types::Schedule> {
        self.schedule.as_ref()
    }
    /// <p>The updated status of the automation rule. Can be Active or Inactive.</p>
    pub fn status(&self) -> ::std::option::Option<&crate::types::RuleStatus> {
        self.status.as_ref()
    }
    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Must be 1-64 characters long and contain only alphanumeric characters, underscores, and hyphens.</p>
    pub fn client_token(&self) -> ::std::option::Option<&str> {
        self.client_token.as_deref()
    }
}
impl UpdateAutomationRuleInput {
    /// Creates a new builder-style object to manufacture [`UpdateAutomationRuleInput`](crate::operation::update_automation_rule::UpdateAutomationRuleInput).
    pub fn builder() -> crate::operation::update_automation_rule::builders::UpdateAutomationRuleInputBuilder {
        crate::operation::update_automation_rule::builders::UpdateAutomationRuleInputBuilder::default()
    }
}

/// A builder for [`UpdateAutomationRuleInput`](crate::operation::update_automation_rule::UpdateAutomationRuleInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct UpdateAutomationRuleInputBuilder {
    pub(crate) rule_arn: ::std::option::Option<::std::string::String>,
    pub(crate) rule_revision: ::std::option::Option<i64>,
    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) client_token: ::std::option::Option<::std::string::String>,
}
impl UpdateAutomationRuleInputBuilder {
    /// <p>The ARN of the rule to update.</p>
    /// This field is required.
    pub fn rule_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.rule_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ARN of the rule to update.</p>
    pub fn set_rule_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.rule_arn = input;
        self
    }
    /// <p>The ARN of the rule to update.</p>
    pub fn get_rule_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.rule_arn
    }
    /// <p>The revision number of the rule to update.</p>
    /// This field is required.
    pub fn rule_revision(mut self, input: i64) -> Self {
        self.rule_revision = ::std::option::Option::Some(input);
        self
    }
    /// <p>The revision number of the rule to update.</p>
    pub fn set_rule_revision(mut self, input: ::std::option::Option<i64>) -> Self {
        self.rule_revision = input;
        self
    }
    /// <p>The revision number of the rule to update.</p>
    pub fn get_rule_revision(&self) -> &::std::option::Option<i64> {
        &self.rule_revision
    }
    /// <p>The updated name of the automation rule. Must be 1-128 characters long and contain only alphanumeric characters, underscores, and hyphens.</p>
    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 updated name of the automation rule. Must be 1-128 characters long and contain only alphanumeric characters, underscores, and hyphens.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The updated name of the automation rule. Must be 1-128 characters long and contain only alphanumeric characters, underscores, and hyphens.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>The updated description of the automation rule. Can be up to 1024 characters long and contain alphanumeric characters, underscores, hyphens, spaces, and certain special characters.</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>The updated description of the automation rule. Can be up to 1024 characters long and contain alphanumeric characters, underscores, hyphens, spaces, and certain special characters.</p>
    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.description = input;
        self
    }
    /// <p>The updated description of the automation rule. Can be up to 1024 characters long and contain alphanumeric characters, underscores, hyphens, spaces, and certain special characters.</p>
    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.description
    }
    /// <p>The updated type of automation rule. Can be either OrganizationRule for organization-wide rules or AccountRule for account-specific rules.</p>
    pub fn rule_type(mut self, input: crate::types::RuleType) -> Self {
        self.rule_type = ::std::option::Option::Some(input);
        self
    }
    /// <p>The updated type of automation rule. Can be either OrganizationRule for organization-wide rules or AccountRule for account-specific rules.</p>
    pub fn set_rule_type(mut self, input: ::std::option::Option<crate::types::RuleType>) -> Self {
        self.rule_type = input;
        self
    }
    /// <p>The updated type of automation rule. Can be either OrganizationRule for organization-wide rules or AccountRule for account-specific rules.</p>
    pub fn get_rule_type(&self) -> &::std::option::Option<crate::types::RuleType> {
        &self.rule_type
    }
    /// <p>Updated configuration settings for organization-wide rules, including rule application order and target account IDs.</p>
    pub fn organization_configuration(mut self, input: crate::types::OrganizationConfiguration) -> Self {
        self.organization_configuration = ::std::option::Option::Some(input);
        self
    }
    /// <p>Updated configuration settings for organization-wide rules, including rule application order and target account IDs.</p>
    pub fn set_organization_configuration(mut self, input: ::std::option::Option<crate::types::OrganizationConfiguration>) -> Self {
        self.organization_configuration = input;
        self
    }
    /// <p>Updated configuration settings for organization-wide rules, including rule application order and target account IDs.</p>
    pub fn get_organization_configuration(&self) -> &::std::option::Option<crate::types::OrganizationConfiguration> {
        &self.organization_configuration
    }
    /// <p>The updated priority level of the automation rule, used to determine execution order when multiple rules apply to the same resource.</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>The updated priority level of the automation rule, used to determine execution order when multiple rules apply to the same resource.</p>
    pub fn set_priority(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.priority = input;
        self
    }
    /// <p>The updated priority level of the automation rule, used to determine execution order when multiple rules apply to the same resource.</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>Updated list of recommended action types that this rule can execute, such as SnapshotAndDeleteUnattachedEbsVolume or UpgradeEbsVolumeType.</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>Updated list of recommended action types that this rule can execute, such as SnapshotAndDeleteUnattachedEbsVolume or UpgradeEbsVolumeType.</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>Updated list of recommended action types that this rule can execute, such as SnapshotAndDeleteUnattachedEbsVolume or UpgradeEbsVolumeType.</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. You can specify up to 20 conditions per filter criteria and 20 values per condition.</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. You can specify up to 20 conditions per filter criteria and 20 values per condition.</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. You can specify up to 20 conditions per filter criteria and 20 values per condition.</p>
    pub fn get_criteria(&self) -> &::std::option::Option<crate::types::Criteria> {
        &self.criteria
    }
    /// <p>The updated schedule configuration for when the automation rule should execute, including cron expression, timezone, and execution window.</p>
    pub fn schedule(mut self, input: crate::types::Schedule) -> Self {
        self.schedule = ::std::option::Option::Some(input);
        self
    }
    /// <p>The updated schedule configuration for when the automation rule should execute, including cron expression, timezone, and execution window.</p>
    pub fn set_schedule(mut self, input: ::std::option::Option<crate::types::Schedule>) -> Self {
        self.schedule = input;
        self
    }
    /// <p>The updated schedule configuration for when the automation rule should execute, including cron expression, timezone, and execution window.</p>
    pub fn get_schedule(&self) -> &::std::option::Option<crate::types::Schedule> {
        &self.schedule
    }
    /// <p>The updated status of the automation rule. Can be Active or Inactive.</p>
    pub fn status(mut self, input: crate::types::RuleStatus) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The updated status of the automation rule. Can be Active or Inactive.</p>
    pub fn set_status(mut self, input: ::std::option::Option<crate::types::RuleStatus>) -> Self {
        self.status = input;
        self
    }
    /// <p>The updated status of the automation rule. Can be Active or Inactive.</p>
    pub fn get_status(&self) -> &::std::option::Option<crate::types::RuleStatus> {
        &self.status
    }
    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Must be 1-64 characters long and contain only alphanumeric characters, underscores, and hyphens.</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 the idempotency of the request. Must be 1-64 characters long and contain only alphanumeric characters, underscores, and hyphens.</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 the idempotency of the request. Must be 1-64 characters long and contain only alphanumeric characters, underscores, and hyphens.</p>
    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.client_token
    }
    /// Consumes the builder and constructs a [`UpdateAutomationRuleInput`](crate::operation::update_automation_rule::UpdateAutomationRuleInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::update_automation_rule::UpdateAutomationRuleInput, ::aws_smithy_types::error::operation::BuildError>
    {
        ::std::result::Result::Ok(crate::operation::update_automation_rule::UpdateAutomationRuleInput {
            rule_arn: self.rule_arn,
            rule_revision: self.rule_revision,
            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,
            client_token: self.client_token,
        })
    }
}