aws-sdk-fsx 1.105.0

AWS SDK for Amazon FSx
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>A snapshot of an Amazon FSx for OpenZFS volume.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct Snapshot {
    /// <p>The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p>
    pub resource_arn: ::std::option::Option<::std::string::String>,
    /// <p>The ID of the snapshot.</p>
    pub snapshot_id: ::std::option::Option<::std::string::String>,
    /// <p>The name of the snapshot.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>The ID of the volume that the snapshot is of.</p>
    pub volume_id: ::std::option::Option<::std::string::String>,
    /// <p>The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.</p>
    pub creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The lifecycle status of the snapshot.</p>
    /// <ul>
    /// <li>
    /// <p><code>PENDING</code> - Amazon FSx hasn't started creating the snapshot.</p></li>
    /// <li>
    /// <p><code>CREATING</code> - Amazon FSx is creating the snapshot.</p></li>
    /// <li>
    /// <p><code>DELETING</code> - Amazon FSx is deleting the snapshot.</p></li>
    /// <li>
    /// <p><code>AVAILABLE</code> - The snapshot is fully available.</p></li>
    /// </ul>
    pub lifecycle: ::std::option::Option<crate::types::SnapshotLifecycle>,
    /// <p>Describes why a resource lifecycle state changed.</p>
    pub lifecycle_transition_reason: ::std::option::Option<crate::types::LifecycleTransitionReason>,
    /// <p>A list of <code>Tag</code> values, with a maximum of 50 elements.</p>
    pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
    /// <p>A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.</p>
    pub administrative_actions: ::std::option::Option<::std::vec::Vec<crate::types::AdministrativeAction>>,
}
impl Snapshot {
    /// <p>The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p>
    pub fn resource_arn(&self) -> ::std::option::Option<&str> {
        self.resource_arn.as_deref()
    }
    /// <p>The ID of the snapshot.</p>
    pub fn snapshot_id(&self) -> ::std::option::Option<&str> {
        self.snapshot_id.as_deref()
    }
    /// <p>The name of the snapshot.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>The ID of the volume that the snapshot is of.</p>
    pub fn volume_id(&self) -> ::std::option::Option<&str> {
        self.volume_id.as_deref()
    }
    /// <p>The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.</p>
    pub fn creation_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.creation_time.as_ref()
    }
    /// <p>The lifecycle status of the snapshot.</p>
    /// <ul>
    /// <li>
    /// <p><code>PENDING</code> - Amazon FSx hasn't started creating the snapshot.</p></li>
    /// <li>
    /// <p><code>CREATING</code> - Amazon FSx is creating the snapshot.</p></li>
    /// <li>
    /// <p><code>DELETING</code> - Amazon FSx is deleting the snapshot.</p></li>
    /// <li>
    /// <p><code>AVAILABLE</code> - The snapshot is fully available.</p></li>
    /// </ul>
    pub fn lifecycle(&self) -> ::std::option::Option<&crate::types::SnapshotLifecycle> {
        self.lifecycle.as_ref()
    }
    /// <p>Describes why a resource lifecycle state changed.</p>
    pub fn lifecycle_transition_reason(&self) -> ::std::option::Option<&crate::types::LifecycleTransitionReason> {
        self.lifecycle_transition_reason.as_ref()
    }
    /// <p>A list of <code>Tag</code> values, with a maximum of 50 elements.</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 list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.</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 `.administrative_actions.is_none()`.
    pub fn administrative_actions(&self) -> &[crate::types::AdministrativeAction] {
        self.administrative_actions.as_deref().unwrap_or_default()
    }
}
impl Snapshot {
    /// Creates a new builder-style object to manufacture [`Snapshot`](crate::types::Snapshot).
    pub fn builder() -> crate::types::builders::SnapshotBuilder {
        crate::types::builders::SnapshotBuilder::default()
    }
}

/// A builder for [`Snapshot`](crate::types::Snapshot).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct SnapshotBuilder {
    pub(crate) resource_arn: ::std::option::Option<::std::string::String>,
    pub(crate) snapshot_id: ::std::option::Option<::std::string::String>,
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) volume_id: ::std::option::Option<::std::string::String>,
    pub(crate) creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) lifecycle: ::std::option::Option<crate::types::SnapshotLifecycle>,
    pub(crate) lifecycle_transition_reason: ::std::option::Option<crate::types::LifecycleTransitionReason>,
    pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
    pub(crate) administrative_actions: ::std::option::Option<::std::vec::Vec<crate::types::AdministrativeAction>>,
}
impl SnapshotBuilder {
    /// <p>The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p>
    pub fn resource_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.resource_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p>
    pub fn set_resource_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.resource_arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p>
    pub fn get_resource_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.resource_arn
    }
    /// <p>The ID of the snapshot.</p>
    pub fn snapshot_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.snapshot_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the snapshot.</p>
    pub fn set_snapshot_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.snapshot_id = input;
        self
    }
    /// <p>The ID of the snapshot.</p>
    pub fn get_snapshot_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.snapshot_id
    }
    /// <p>The name of the snapshot.</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 name of the snapshot.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The name of the snapshot.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>The ID of the volume that the snapshot is of.</p>
    pub fn volume_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.volume_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the volume that the snapshot is of.</p>
    pub fn set_volume_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.volume_id = input;
        self
    }
    /// <p>The ID of the volume that the snapshot is of.</p>
    pub fn get_volume_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.volume_id
    }
    /// <p>The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.</p>
    pub fn creation_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.creation_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.</p>
    pub fn set_creation_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.creation_time = input;
        self
    }
    /// <p>The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.</p>
    pub fn get_creation_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.creation_time
    }
    /// <p>The lifecycle status of the snapshot.</p>
    /// <ul>
    /// <li>
    /// <p><code>PENDING</code> - Amazon FSx hasn't started creating the snapshot.</p></li>
    /// <li>
    /// <p><code>CREATING</code> - Amazon FSx is creating the snapshot.</p></li>
    /// <li>
    /// <p><code>DELETING</code> - Amazon FSx is deleting the snapshot.</p></li>
    /// <li>
    /// <p><code>AVAILABLE</code> - The snapshot is fully available.</p></li>
    /// </ul>
    pub fn lifecycle(mut self, input: crate::types::SnapshotLifecycle) -> Self {
        self.lifecycle = ::std::option::Option::Some(input);
        self
    }
    /// <p>The lifecycle status of the snapshot.</p>
    /// <ul>
    /// <li>
    /// <p><code>PENDING</code> - Amazon FSx hasn't started creating the snapshot.</p></li>
    /// <li>
    /// <p><code>CREATING</code> - Amazon FSx is creating the snapshot.</p></li>
    /// <li>
    /// <p><code>DELETING</code> - Amazon FSx is deleting the snapshot.</p></li>
    /// <li>
    /// <p><code>AVAILABLE</code> - The snapshot is fully available.</p></li>
    /// </ul>
    pub fn set_lifecycle(mut self, input: ::std::option::Option<crate::types::SnapshotLifecycle>) -> Self {
        self.lifecycle = input;
        self
    }
    /// <p>The lifecycle status of the snapshot.</p>
    /// <ul>
    /// <li>
    /// <p><code>PENDING</code> - Amazon FSx hasn't started creating the snapshot.</p></li>
    /// <li>
    /// <p><code>CREATING</code> - Amazon FSx is creating the snapshot.</p></li>
    /// <li>
    /// <p><code>DELETING</code> - Amazon FSx is deleting the snapshot.</p></li>
    /// <li>
    /// <p><code>AVAILABLE</code> - The snapshot is fully available.</p></li>
    /// </ul>
    pub fn get_lifecycle(&self) -> &::std::option::Option<crate::types::SnapshotLifecycle> {
        &self.lifecycle
    }
    /// <p>Describes why a resource lifecycle state changed.</p>
    pub fn lifecycle_transition_reason(mut self, input: crate::types::LifecycleTransitionReason) -> Self {
        self.lifecycle_transition_reason = ::std::option::Option::Some(input);
        self
    }
    /// <p>Describes why a resource lifecycle state changed.</p>
    pub fn set_lifecycle_transition_reason(mut self, input: ::std::option::Option<crate::types::LifecycleTransitionReason>) -> Self {
        self.lifecycle_transition_reason = input;
        self
    }
    /// <p>Describes why a resource lifecycle state changed.</p>
    pub fn get_lifecycle_transition_reason(&self) -> &::std::option::Option<crate::types::LifecycleTransitionReason> {
        &self.lifecycle_transition_reason
    }
    /// Appends an item to `tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>A list of <code>Tag</code> values, with a maximum of 50 elements.</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>A list of <code>Tag</code> values, with a maximum of 50 elements.</p>
    pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
        self.tags = input;
        self
    }
    /// <p>A list of <code>Tag</code> values, with a maximum of 50 elements.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
        &self.tags
    }
    /// Appends an item to `administrative_actions`.
    ///
    /// To override the contents of this collection use [`set_administrative_actions`](Self::set_administrative_actions).
    ///
    /// <p>A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.</p>
    pub fn administrative_actions(mut self, input: crate::types::AdministrativeAction) -> Self {
        let mut v = self.administrative_actions.unwrap_or_default();
        v.push(input);
        self.administrative_actions = ::std::option::Option::Some(v);
        self
    }
    /// <p>A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.</p>
    pub fn set_administrative_actions(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::AdministrativeAction>>) -> Self {
        self.administrative_actions = input;
        self
    }
    /// <p>A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.</p>
    pub fn get_administrative_actions(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::AdministrativeAction>> {
        &self.administrative_actions
    }
    /// Consumes the builder and constructs a [`Snapshot`](crate::types::Snapshot).
    pub fn build(self) -> crate::types::Snapshot {
        crate::types::Snapshot {
            resource_arn: self.resource_arn,
            snapshot_id: self.snapshot_id,
            name: self.name,
            volume_id: self.volume_id,
            creation_time: self.creation_time,
            lifecycle: self.lifecycle,
            lifecycle_transition_reason: self.lifecycle_transition_reason,
            tags: self.tags,
            administrative_actions: self.administrative_actions,
        }
    }
}