aws-sdk-sms 1.32.0

AWS SDK for AWS Server Migration Service
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 UpdateReplicationJobInput {
    /// <p>The ID of the replication job.</p>
    pub replication_job_id: ::std::option::Option<::std::string::String>,
    /// <p>The time between consecutive replication runs, in hours.</p>
    pub frequency: ::std::option::Option<i32>,
    /// <p>The start time of the next replication run.</p>
    pub next_replication_run_start_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The license type to be used for the AMI created by a successful replication run.</p>
    pub license_type: ::std::option::Option<crate::types::LicenseType>,
    /// <p>The name of the IAM role to be used by Server Migration Service.</p>
    pub role_name: ::std::option::Option<::std::string::String>,
    /// <p>The description of the replication job.</p>
    pub description: ::std::option::Option<::std::string::String>,
    /// <p>The maximum number of SMS-created AMIs to retain. The oldest is deleted after the maximum number is reached and a new AMI is created.</p>
    pub number_of_recent_amis_to_keep: ::std::option::Option<i32>,
    /// <p>When true, the replication job produces encrypted AMIs. For more information, <code>KmsKeyId</code>.</p>
    pub encrypted: ::std::option::Option<bool>,
    /// <p>The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:</p>
    /// <ul>
    /// <li>
    /// <p>KMS key ID</p></li>
    /// <li>
    /// <p>KMS key alias</p></li>
    /// <li>
    /// <p>ARN referring to the KMS key ID</p></li>
    /// <li>
    /// <p>ARN referring to the KMS key alias</p></li>
    /// </ul>
    /// <p>If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.</p>
    pub kms_key_id: ::std::option::Option<::std::string::String>,
}
impl UpdateReplicationJobInput {
    /// <p>The ID of the replication job.</p>
    pub fn replication_job_id(&self) -> ::std::option::Option<&str> {
        self.replication_job_id.as_deref()
    }
    /// <p>The time between consecutive replication runs, in hours.</p>
    pub fn frequency(&self) -> ::std::option::Option<i32> {
        self.frequency
    }
    /// <p>The start time of the next replication run.</p>
    pub fn next_replication_run_start_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.next_replication_run_start_time.as_ref()
    }
    /// <p>The license type to be used for the AMI created by a successful replication run.</p>
    pub fn license_type(&self) -> ::std::option::Option<&crate::types::LicenseType> {
        self.license_type.as_ref()
    }
    /// <p>The name of the IAM role to be used by Server Migration Service.</p>
    pub fn role_name(&self) -> ::std::option::Option<&str> {
        self.role_name.as_deref()
    }
    /// <p>The description of the replication job.</p>
    pub fn description(&self) -> ::std::option::Option<&str> {
        self.description.as_deref()
    }
    /// <p>The maximum number of SMS-created AMIs to retain. The oldest is deleted after the maximum number is reached and a new AMI is created.</p>
    pub fn number_of_recent_amis_to_keep(&self) -> ::std::option::Option<i32> {
        self.number_of_recent_amis_to_keep
    }
    /// <p>When true, the replication job produces encrypted AMIs. For more information, <code>KmsKeyId</code>.</p>
    pub fn encrypted(&self) -> ::std::option::Option<bool> {
        self.encrypted
    }
    /// <p>The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:</p>
    /// <ul>
    /// <li>
    /// <p>KMS key ID</p></li>
    /// <li>
    /// <p>KMS key alias</p></li>
    /// <li>
    /// <p>ARN referring to the KMS key ID</p></li>
    /// <li>
    /// <p>ARN referring to the KMS key alias</p></li>
    /// </ul>
    /// <p>If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.</p>
    pub fn kms_key_id(&self) -> ::std::option::Option<&str> {
        self.kms_key_id.as_deref()
    }
}
impl UpdateReplicationJobInput {
    /// Creates a new builder-style object to manufacture [`UpdateReplicationJobInput`](crate::operation::update_replication_job::UpdateReplicationJobInput).
    pub fn builder() -> crate::operation::update_replication_job::builders::UpdateReplicationJobInputBuilder {
        crate::operation::update_replication_job::builders::UpdateReplicationJobInputBuilder::default()
    }
}

/// A builder for [`UpdateReplicationJobInput`](crate::operation::update_replication_job::UpdateReplicationJobInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct UpdateReplicationJobInputBuilder {
    pub(crate) replication_job_id: ::std::option::Option<::std::string::String>,
    pub(crate) frequency: ::std::option::Option<i32>,
    pub(crate) next_replication_run_start_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) license_type: ::std::option::Option<crate::types::LicenseType>,
    pub(crate) role_name: ::std::option::Option<::std::string::String>,
    pub(crate) description: ::std::option::Option<::std::string::String>,
    pub(crate) number_of_recent_amis_to_keep: ::std::option::Option<i32>,
    pub(crate) encrypted: ::std::option::Option<bool>,
    pub(crate) kms_key_id: ::std::option::Option<::std::string::String>,
}
impl UpdateReplicationJobInputBuilder {
    /// <p>The ID of the replication job.</p>
    /// This field is required.
    pub fn replication_job_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.replication_job_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the replication job.</p>
    pub fn set_replication_job_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.replication_job_id = input;
        self
    }
    /// <p>The ID of the replication job.</p>
    pub fn get_replication_job_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.replication_job_id
    }
    /// <p>The time between consecutive replication runs, in hours.</p>
    pub fn frequency(mut self, input: i32) -> Self {
        self.frequency = ::std::option::Option::Some(input);
        self
    }
    /// <p>The time between consecutive replication runs, in hours.</p>
    pub fn set_frequency(mut self, input: ::std::option::Option<i32>) -> Self {
        self.frequency = input;
        self
    }
    /// <p>The time between consecutive replication runs, in hours.</p>
    pub fn get_frequency(&self) -> &::std::option::Option<i32> {
        &self.frequency
    }
    /// <p>The start time of the next replication run.</p>
    pub fn next_replication_run_start_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.next_replication_run_start_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The start time of the next replication run.</p>
    pub fn set_next_replication_run_start_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.next_replication_run_start_time = input;
        self
    }
    /// <p>The start time of the next replication run.</p>
    pub fn get_next_replication_run_start_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.next_replication_run_start_time
    }
    /// <p>The license type to be used for the AMI created by a successful replication run.</p>
    pub fn license_type(mut self, input: crate::types::LicenseType) -> Self {
        self.license_type = ::std::option::Option::Some(input);
        self
    }
    /// <p>The license type to be used for the AMI created by a successful replication run.</p>
    pub fn set_license_type(mut self, input: ::std::option::Option<crate::types::LicenseType>) -> Self {
        self.license_type = input;
        self
    }
    /// <p>The license type to be used for the AMI created by a successful replication run.</p>
    pub fn get_license_type(&self) -> &::std::option::Option<crate::types::LicenseType> {
        &self.license_type
    }
    /// <p>The name of the IAM role to be used by Server Migration Service.</p>
    pub fn role_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.role_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the IAM role to be used by Server Migration Service.</p>
    pub fn set_role_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.role_name = input;
        self
    }
    /// <p>The name of the IAM role to be used by Server Migration Service.</p>
    pub fn get_role_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.role_name
    }
    /// <p>The description of the replication job.</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 description of the replication job.</p>
    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.description = input;
        self
    }
    /// <p>The description of the replication job.</p>
    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.description
    }
    /// <p>The maximum number of SMS-created AMIs to retain. The oldest is deleted after the maximum number is reached and a new AMI is created.</p>
    pub fn number_of_recent_amis_to_keep(mut self, input: i32) -> Self {
        self.number_of_recent_amis_to_keep = ::std::option::Option::Some(input);
        self
    }
    /// <p>The maximum number of SMS-created AMIs to retain. The oldest is deleted after the maximum number is reached and a new AMI is created.</p>
    pub fn set_number_of_recent_amis_to_keep(mut self, input: ::std::option::Option<i32>) -> Self {
        self.number_of_recent_amis_to_keep = input;
        self
    }
    /// <p>The maximum number of SMS-created AMIs to retain. The oldest is deleted after the maximum number is reached and a new AMI is created.</p>
    pub fn get_number_of_recent_amis_to_keep(&self) -> &::std::option::Option<i32> {
        &self.number_of_recent_amis_to_keep
    }
    /// <p>When true, the replication job produces encrypted AMIs. For more information, <code>KmsKeyId</code>.</p>
    pub fn encrypted(mut self, input: bool) -> Self {
        self.encrypted = ::std::option::Option::Some(input);
        self
    }
    /// <p>When true, the replication job produces encrypted AMIs. For more information, <code>KmsKeyId</code>.</p>
    pub fn set_encrypted(mut self, input: ::std::option::Option<bool>) -> Self {
        self.encrypted = input;
        self
    }
    /// <p>When true, the replication job produces encrypted AMIs. For more information, <code>KmsKeyId</code>.</p>
    pub fn get_encrypted(&self) -> &::std::option::Option<bool> {
        &self.encrypted
    }
    /// <p>The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:</p>
    /// <ul>
    /// <li>
    /// <p>KMS key ID</p></li>
    /// <li>
    /// <p>KMS key alias</p></li>
    /// <li>
    /// <p>ARN referring to the KMS key ID</p></li>
    /// <li>
    /// <p>ARN referring to the KMS key alias</p></li>
    /// </ul>
    /// <p>If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.</p>
    pub fn kms_key_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.kms_key_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:</p>
    /// <ul>
    /// <li>
    /// <p>KMS key ID</p></li>
    /// <li>
    /// <p>KMS key alias</p></li>
    /// <li>
    /// <p>ARN referring to the KMS key ID</p></li>
    /// <li>
    /// <p>ARN referring to the KMS key alias</p></li>
    /// </ul>
    /// <p>If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.</p>
    pub fn set_kms_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.kms_key_id = input;
        self
    }
    /// <p>The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:</p>
    /// <ul>
    /// <li>
    /// <p>KMS key ID</p></li>
    /// <li>
    /// <p>KMS key alias</p></li>
    /// <li>
    /// <p>ARN referring to the KMS key ID</p></li>
    /// <li>
    /// <p>ARN referring to the KMS key alias</p></li>
    /// </ul>
    /// <p>If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.</p>
    pub fn get_kms_key_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.kms_key_id
    }
    /// Consumes the builder and constructs a [`UpdateReplicationJobInput`](crate::operation::update_replication_job::UpdateReplicationJobInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::update_replication_job::UpdateReplicationJobInput, ::aws_smithy_types::error::operation::BuildError>
    {
        ::std::result::Result::Ok(crate::operation::update_replication_job::UpdateReplicationJobInput {
            replication_job_id: self.replication_job_id,
            frequency: self.frequency,
            next_replication_run_start_time: self.next_replication_run_start_time,
            license_type: self.license_type,
            role_name: self.role_name,
            description: self.description,
            number_of_recent_amis_to_keep: self.number_of_recent_amis_to_keep,
            encrypted: self.encrypted,
            kms_key_id: self.kms_key_id,
        })
    }
}