aws-sdk-wellarchitected 1.110.0

AWS SDK for AWS Well-Architected Tool
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)]
pub struct CreateAgentProfileInput {
    /// <p>The system name of the profile.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>The display name of the profile shown to users.</p>
    pub display_name: ::std::option::Option<::std::string::String>,
    /// <p>A description of the profile.</p>
    pub description: ::std::option::Option<::std::string::String>,
    /// <p>The business overview for this profile.</p>
    pub business_overview: ::std::option::Option<::std::string::String>,
    /// <p>The Well-Architected Tool Framework pillars to associate with this profile.</p>
    pub pillars: ::std::option::Option<::std::vec::Vec<crate::types::Pillar>>,
    /// <p>Indicates whether deletion protection is enabled for the profile.</p>
    pub deletion_protection: ::std::option::Option<bool>,
    /// <p>The ARN of the IAM execution role used for recommendation actions.</p>
    pub execution_role_arn: ::std::option::Option<::std::string::String>,
    /// <p>The aggregation configuration that defines which Amazon Web Services accounts and Regions to analyze.</p>
    pub aggregation_configuration: ::std::option::Option<::std::vec::Vec<crate::types::AggregationConfiguration>>,
    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
    pub client_token: ::std::option::Option<::std::string::String>,
    /// <p>The tags to associate with the profile.</p>
    pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl CreateAgentProfileInput {
    /// <p>The system name of the profile.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>The display name of the profile shown to users.</p>
    pub fn display_name(&self) -> ::std::option::Option<&str> {
        self.display_name.as_deref()
    }
    /// <p>A description of the profile.</p>
    pub fn description(&self) -> ::std::option::Option<&str> {
        self.description.as_deref()
    }
    /// <p>The business overview for this profile.</p>
    pub fn business_overview(&self) -> ::std::option::Option<&str> {
        self.business_overview.as_deref()
    }
    /// <p>The Well-Architected Tool Framework pillars to associate with this profile.</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 `.pillars.is_none()`.
    pub fn pillars(&self) -> &[crate::types::Pillar] {
        self.pillars.as_deref().unwrap_or_default()
    }
    /// <p>Indicates whether deletion protection is enabled for the profile.</p>
    pub fn deletion_protection(&self) -> ::std::option::Option<bool> {
        self.deletion_protection
    }
    /// <p>The ARN of the IAM execution role used for recommendation actions.</p>
    pub fn execution_role_arn(&self) -> ::std::option::Option<&str> {
        self.execution_role_arn.as_deref()
    }
    /// <p>The aggregation configuration that defines which Amazon Web Services accounts and Regions to analyze.</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 `.aggregation_configuration.is_none()`.
    pub fn aggregation_configuration(&self) -> &[crate::types::AggregationConfiguration] {
        self.aggregation_configuration.as_deref().unwrap_or_default()
    }
    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
    pub fn client_token(&self) -> ::std::option::Option<&str> {
        self.client_token.as_deref()
    }
    /// <p>The tags to associate with the profile.</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()
    }
}
impl ::std::fmt::Debug for CreateAgentProfileInput {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("CreateAgentProfileInput");
        formatter.field("name", &self.name);
        formatter.field("display_name", &"*** Sensitive Data Redacted ***");
        formatter.field("description", &"*** Sensitive Data Redacted ***");
        formatter.field("business_overview", &"*** Sensitive Data Redacted ***");
        formatter.field("pillars", &self.pillars);
        formatter.field("deletion_protection", &self.deletion_protection);
        formatter.field("execution_role_arn", &self.execution_role_arn);
        formatter.field("aggregation_configuration", &self.aggregation_configuration);
        formatter.field("client_token", &self.client_token);
        formatter.field("tags", &self.tags);
        formatter.finish()
    }
}
impl CreateAgentProfileInput {
    /// Creates a new builder-style object to manufacture [`CreateAgentProfileInput`](crate::operation::create_agent_profile::CreateAgentProfileInput).
    pub fn builder() -> crate::operation::create_agent_profile::builders::CreateAgentProfileInputBuilder {
        crate::operation::create_agent_profile::builders::CreateAgentProfileInputBuilder::default()
    }
}

/// A builder for [`CreateAgentProfileInput`](crate::operation::create_agent_profile::CreateAgentProfileInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
pub struct CreateAgentProfileInputBuilder {
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) display_name: ::std::option::Option<::std::string::String>,
    pub(crate) description: ::std::option::Option<::std::string::String>,
    pub(crate) business_overview: ::std::option::Option<::std::string::String>,
    pub(crate) pillars: ::std::option::Option<::std::vec::Vec<crate::types::Pillar>>,
    pub(crate) deletion_protection: ::std::option::Option<bool>,
    pub(crate) execution_role_arn: ::std::option::Option<::std::string::String>,
    pub(crate) aggregation_configuration: ::std::option::Option<::std::vec::Vec<crate::types::AggregationConfiguration>>,
    pub(crate) client_token: ::std::option::Option<::std::string::String>,
    pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl CreateAgentProfileInputBuilder {
    /// <p>The system name of the profile.</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 system name of the profile.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The system name of the profile.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>The display name of the profile shown to users.</p>
    pub fn display_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.display_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The display name of the profile shown to users.</p>
    pub fn set_display_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.display_name = input;
        self
    }
    /// <p>The display name of the profile shown to users.</p>
    pub fn get_display_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.display_name
    }
    /// <p>A description of the profile.</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 profile.</p>
    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.description = input;
        self
    }
    /// <p>A description of the profile.</p>
    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.description
    }
    /// <p>The business overview for this profile.</p>
    pub fn business_overview(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.business_overview = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The business overview for this profile.</p>
    pub fn set_business_overview(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.business_overview = input;
        self
    }
    /// <p>The business overview for this profile.</p>
    pub fn get_business_overview(&self) -> &::std::option::Option<::std::string::String> {
        &self.business_overview
    }
    /// Appends an item to `pillars`.
    ///
    /// To override the contents of this collection use [`set_pillars`](Self::set_pillars).
    ///
    /// <p>The Well-Architected Tool Framework pillars to associate with this profile.</p>
    pub fn pillars(mut self, input: crate::types::Pillar) -> Self {
        let mut v = self.pillars.unwrap_or_default();
        v.push(input);
        self.pillars = ::std::option::Option::Some(v);
        self
    }
    /// <p>The Well-Architected Tool Framework pillars to associate with this profile.</p>
    pub fn set_pillars(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Pillar>>) -> Self {
        self.pillars = input;
        self
    }
    /// <p>The Well-Architected Tool Framework pillars to associate with this profile.</p>
    pub fn get_pillars(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Pillar>> {
        &self.pillars
    }
    /// <p>Indicates whether deletion protection is enabled for the profile.</p>
    pub fn deletion_protection(mut self, input: bool) -> Self {
        self.deletion_protection = ::std::option::Option::Some(input);
        self
    }
    /// <p>Indicates whether deletion protection is enabled for the profile.</p>
    pub fn set_deletion_protection(mut self, input: ::std::option::Option<bool>) -> Self {
        self.deletion_protection = input;
        self
    }
    /// <p>Indicates whether deletion protection is enabled for the profile.</p>
    pub fn get_deletion_protection(&self) -> &::std::option::Option<bool> {
        &self.deletion_protection
    }
    /// <p>The ARN of the IAM execution role used for recommendation actions.</p>
    /// This field is required.
    pub fn execution_role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.execution_role_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ARN of the IAM execution role used for recommendation actions.</p>
    pub fn set_execution_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.execution_role_arn = input;
        self
    }
    /// <p>The ARN of the IAM execution role used for recommendation actions.</p>
    pub fn get_execution_role_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.execution_role_arn
    }
    /// Appends an item to `aggregation_configuration`.
    ///
    /// To override the contents of this collection use [`set_aggregation_configuration`](Self::set_aggregation_configuration).
    ///
    /// <p>The aggregation configuration that defines which Amazon Web Services accounts and Regions to analyze.</p>
    pub fn aggregation_configuration(mut self, input: crate::types::AggregationConfiguration) -> Self {
        let mut v = self.aggregation_configuration.unwrap_or_default();
        v.push(input);
        self.aggregation_configuration = ::std::option::Option::Some(v);
        self
    }
    /// <p>The aggregation configuration that defines which Amazon Web Services accounts and Regions to analyze.</p>
    pub fn set_aggregation_configuration(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::AggregationConfiguration>>) -> Self {
        self.aggregation_configuration = input;
        self
    }
    /// <p>The aggregation configuration that defines which Amazon Web Services accounts and Regions to analyze.</p>
    pub fn get_aggregation_configuration(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::AggregationConfiguration>> {
        &self.aggregation_configuration
    }
    /// <p>A unique, case-sensitive identifier that you provide to ensure the 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, case-sensitive identifier that you provide to ensure the 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, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.client_token
    }
    /// 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 profile.</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 profile.</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 profile.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
        &self.tags
    }
    /// Consumes the builder and constructs a [`CreateAgentProfileInput`](crate::operation::create_agent_profile::CreateAgentProfileInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::create_agent_profile::CreateAgentProfileInput, ::aws_smithy_types::error::operation::BuildError>
    {
        ::std::result::Result::Ok(crate::operation::create_agent_profile::CreateAgentProfileInput {
            name: self.name,
            display_name: self.display_name,
            description: self.description,
            business_overview: self.business_overview,
            pillars: self.pillars,
            deletion_protection: self.deletion_protection,
            execution_role_arn: self.execution_role_arn,
            aggregation_configuration: self.aggregation_configuration,
            client_token: self.client_token,
            tags: self.tags,
        })
    }
}
impl ::std::fmt::Debug for CreateAgentProfileInputBuilder {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("CreateAgentProfileInputBuilder");
        formatter.field("name", &self.name);
        formatter.field("display_name", &"*** Sensitive Data Redacted ***");
        formatter.field("description", &"*** Sensitive Data Redacted ***");
        formatter.field("business_overview", &"*** Sensitive Data Redacted ***");
        formatter.field("pillars", &self.pillars);
        formatter.field("deletion_protection", &self.deletion_protection);
        formatter.field("execution_role_arn", &self.execution_role_arn);
        formatter.field("aggregation_configuration", &self.aggregation_configuration);
        formatter.field("client_token", &self.client_token);
        formatter.field("tags", &self.tags);
        formatter.finish()
    }
}