aws-sdk-opensearchserverless 1.100.0

AWS SDK for OpenSearch Service Serverless
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 UpdateSecurityConfigInput {
    /// <p>The security configuration identifier. For SAML the ID will be <code>saml/&lt;accountId&gt;/&lt;idpProviderName&gt;</code>. For example, <code>saml/123456789123/OKTADev</code>.</p>
    pub id: ::std::option::Option<::std::string::String>,
    /// <p>The version of the security configuration to be updated. You can find the most recent version of a security configuration using the <code>GetSecurityPolicy</code> command.</p>
    pub config_version: ::std::option::Option<::std::string::String>,
    /// <p>A description of the security configuration.</p>
    pub description: ::std::option::Option<::std::string::String>,
    /// <p>SAML options in in the form of a key-value map.</p>
    pub saml_options: ::std::option::Option<crate::types::SamlConfigOptions>,
    /// <p>Describes IAM Identity Center options in the form of a key-value map.</p>
    pub iam_identity_center_options_updates: ::std::option::Option<crate::types::UpdateIamIdentityCenterConfigOptions>,
    /// <p>Describes IAM federation options in the form of a key-value map for updating an existing security configuration. Use this field to modify IAM federation settings for the security configuration.</p>
    pub iam_federation_options: ::std::option::Option<crate::types::IamFederationConfigOptions>,
    /// <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
    pub client_token: ::std::option::Option<::std::string::String>,
}
impl UpdateSecurityConfigInput {
    /// <p>The security configuration identifier. For SAML the ID will be <code>saml/&lt;accountId&gt;/&lt;idpProviderName&gt;</code>. For example, <code>saml/123456789123/OKTADev</code>.</p>
    pub fn id(&self) -> ::std::option::Option<&str> {
        self.id.as_deref()
    }
    /// <p>The version of the security configuration to be updated. You can find the most recent version of a security configuration using the <code>GetSecurityPolicy</code> command.</p>
    pub fn config_version(&self) -> ::std::option::Option<&str> {
        self.config_version.as_deref()
    }
    /// <p>A description of the security configuration.</p>
    pub fn description(&self) -> ::std::option::Option<&str> {
        self.description.as_deref()
    }
    /// <p>SAML options in in the form of a key-value map.</p>
    pub fn saml_options(&self) -> ::std::option::Option<&crate::types::SamlConfigOptions> {
        self.saml_options.as_ref()
    }
    /// <p>Describes IAM Identity Center options in the form of a key-value map.</p>
    pub fn iam_identity_center_options_updates(&self) -> ::std::option::Option<&crate::types::UpdateIamIdentityCenterConfigOptions> {
        self.iam_identity_center_options_updates.as_ref()
    }
    /// <p>Describes IAM federation options in the form of a key-value map for updating an existing security configuration. Use this field to modify IAM federation settings for the security configuration.</p>
    pub fn iam_federation_options(&self) -> ::std::option::Option<&crate::types::IamFederationConfigOptions> {
        self.iam_federation_options.as_ref()
    }
    /// <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
    pub fn client_token(&self) -> ::std::option::Option<&str> {
        self.client_token.as_deref()
    }
}
impl UpdateSecurityConfigInput {
    /// Creates a new builder-style object to manufacture [`UpdateSecurityConfigInput`](crate::operation::update_security_config::UpdateSecurityConfigInput).
    pub fn builder() -> crate::operation::update_security_config::builders::UpdateSecurityConfigInputBuilder {
        crate::operation::update_security_config::builders::UpdateSecurityConfigInputBuilder::default()
    }
}

/// A builder for [`UpdateSecurityConfigInput`](crate::operation::update_security_config::UpdateSecurityConfigInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct UpdateSecurityConfigInputBuilder {
    pub(crate) id: ::std::option::Option<::std::string::String>,
    pub(crate) config_version: ::std::option::Option<::std::string::String>,
    pub(crate) description: ::std::option::Option<::std::string::String>,
    pub(crate) saml_options: ::std::option::Option<crate::types::SamlConfigOptions>,
    pub(crate) iam_identity_center_options_updates: ::std::option::Option<crate::types::UpdateIamIdentityCenterConfigOptions>,
    pub(crate) iam_federation_options: ::std::option::Option<crate::types::IamFederationConfigOptions>,
    pub(crate) client_token: ::std::option::Option<::std::string::String>,
}
impl UpdateSecurityConfigInputBuilder {
    /// <p>The security configuration identifier. For SAML the ID will be <code>saml/&lt;accountId&gt;/&lt;idpProviderName&gt;</code>. For example, <code>saml/123456789123/OKTADev</code>.</p>
    /// This field is required.
    pub fn id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The security configuration identifier. For SAML the ID will be <code>saml/&lt;accountId&gt;/&lt;idpProviderName&gt;</code>. For example, <code>saml/123456789123/OKTADev</code>.</p>
    pub fn set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.id = input;
        self
    }
    /// <p>The security configuration identifier. For SAML the ID will be <code>saml/&lt;accountId&gt;/&lt;idpProviderName&gt;</code>. For example, <code>saml/123456789123/OKTADev</code>.</p>
    pub fn get_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.id
    }
    /// <p>The version of the security configuration to be updated. You can find the most recent version of a security configuration using the <code>GetSecurityPolicy</code> command.</p>
    /// This field is required.
    pub fn config_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.config_version = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The version of the security configuration to be updated. You can find the most recent version of a security configuration using the <code>GetSecurityPolicy</code> command.</p>
    pub fn set_config_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.config_version = input;
        self
    }
    /// <p>The version of the security configuration to be updated. You can find the most recent version of a security configuration using the <code>GetSecurityPolicy</code> command.</p>
    pub fn get_config_version(&self) -> &::std::option::Option<::std::string::String> {
        &self.config_version
    }
    /// <p>A description of the security configuration.</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 security configuration.</p>
    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.description = input;
        self
    }
    /// <p>A description of the security configuration.</p>
    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.description
    }
    /// <p>SAML options in in the form of a key-value map.</p>
    pub fn saml_options(mut self, input: crate::types::SamlConfigOptions) -> Self {
        self.saml_options = ::std::option::Option::Some(input);
        self
    }
    /// <p>SAML options in in the form of a key-value map.</p>
    pub fn set_saml_options(mut self, input: ::std::option::Option<crate::types::SamlConfigOptions>) -> Self {
        self.saml_options = input;
        self
    }
    /// <p>SAML options in in the form of a key-value map.</p>
    pub fn get_saml_options(&self) -> &::std::option::Option<crate::types::SamlConfigOptions> {
        &self.saml_options
    }
    /// <p>Describes IAM Identity Center options in the form of a key-value map.</p>
    pub fn iam_identity_center_options_updates(mut self, input: crate::types::UpdateIamIdentityCenterConfigOptions) -> Self {
        self.iam_identity_center_options_updates = ::std::option::Option::Some(input);
        self
    }
    /// <p>Describes IAM Identity Center options in the form of a key-value map.</p>
    pub fn set_iam_identity_center_options_updates(
        mut self,
        input: ::std::option::Option<crate::types::UpdateIamIdentityCenterConfigOptions>,
    ) -> Self {
        self.iam_identity_center_options_updates = input;
        self
    }
    /// <p>Describes IAM Identity Center options in the form of a key-value map.</p>
    pub fn get_iam_identity_center_options_updates(&self) -> &::std::option::Option<crate::types::UpdateIamIdentityCenterConfigOptions> {
        &self.iam_identity_center_options_updates
    }
    /// <p>Describes IAM federation options in the form of a key-value map for updating an existing security configuration. Use this field to modify IAM federation settings for the security configuration.</p>
    pub fn iam_federation_options(mut self, input: crate::types::IamFederationConfigOptions) -> Self {
        self.iam_federation_options = ::std::option::Option::Some(input);
        self
    }
    /// <p>Describes IAM federation options in the form of a key-value map for updating an existing security configuration. Use this field to modify IAM federation settings for the security configuration.</p>
    pub fn set_iam_federation_options(mut self, input: ::std::option::Option<crate::types::IamFederationConfigOptions>) -> Self {
        self.iam_federation_options = input;
        self
    }
    /// <p>Describes IAM federation options in the form of a key-value map for updating an existing security configuration. Use this field to modify IAM federation settings for the security configuration.</p>
    pub fn get_iam_federation_options(&self) -> &::std::option::Option<crate::types::IamFederationConfigOptions> {
        &self.iam_federation_options
    }
    /// <p>Unique, case-sensitive 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>Unique, case-sensitive 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>Unique, case-sensitive 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 [`UpdateSecurityConfigInput`](crate::operation::update_security_config::UpdateSecurityConfigInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::update_security_config::UpdateSecurityConfigInput, ::aws_smithy_types::error::operation::BuildError>
    {
        ::std::result::Result::Ok(crate::operation::update_security_config::UpdateSecurityConfigInput {
            id: self.id,
            config_version: self.config_version,
            description: self.description,
            saml_options: self.saml_options,
            iam_identity_center_options_updates: self.iam_identity_center_options_updates,
            iam_federation_options: self.iam_federation_options,
            client_token: self.client_token,
        })
    }
}