aws-sdk-s3outposts 1.23.0

AWS SDK for Amazon S3 on Outposts
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>Contains the details for the Outpost object.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct Outpost {
    /// <p>Specifies the unique Amazon Resource Name (ARN) for the outpost.</p>
    pub outpost_arn: ::std::option::Option<::std::string::String>,
    /// <p>Specifies the unique S3 on Outposts ARN for use with Resource Access Manager (RAM).</p>
    pub s3_outpost_arn: ::std::option::Option<::std::string::String>,
    /// <p>Specifies the unique identifier for the outpost.</p>
    pub outpost_id: ::std::option::Option<::std::string::String>,
    /// <p>Returns the Amazon Web Services account ID of the outpost owner. Useful for comparing owned versus shared outposts.</p>
    pub owner_id: ::std::option::Option<::std::string::String>,
    /// <p>The Amazon S3 capacity of the outpost in bytes.</p>
    pub capacity_in_bytes: i64,
}
impl Outpost {
    /// <p>Specifies the unique Amazon Resource Name (ARN) for the outpost.</p>
    pub fn outpost_arn(&self) -> ::std::option::Option<&str> {
        self.outpost_arn.as_deref()
    }
    /// <p>Specifies the unique S3 on Outposts ARN for use with Resource Access Manager (RAM).</p>
    pub fn s3_outpost_arn(&self) -> ::std::option::Option<&str> {
        self.s3_outpost_arn.as_deref()
    }
    /// <p>Specifies the unique identifier for the outpost.</p>
    pub fn outpost_id(&self) -> ::std::option::Option<&str> {
        self.outpost_id.as_deref()
    }
    /// <p>Returns the Amazon Web Services account ID of the outpost owner. Useful for comparing owned versus shared outposts.</p>
    pub fn owner_id(&self) -> ::std::option::Option<&str> {
        self.owner_id.as_deref()
    }
    /// <p>The Amazon S3 capacity of the outpost in bytes.</p>
    pub fn capacity_in_bytes(&self) -> i64 {
        self.capacity_in_bytes
    }
}
impl Outpost {
    /// Creates a new builder-style object to manufacture [`Outpost`](crate::types::Outpost).
    pub fn builder() -> crate::types::builders::OutpostBuilder {
        crate::types::builders::OutpostBuilder::default()
    }
}

/// A builder for [`Outpost`](crate::types::Outpost).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct OutpostBuilder {
    pub(crate) outpost_arn: ::std::option::Option<::std::string::String>,
    pub(crate) s3_outpost_arn: ::std::option::Option<::std::string::String>,
    pub(crate) outpost_id: ::std::option::Option<::std::string::String>,
    pub(crate) owner_id: ::std::option::Option<::std::string::String>,
    pub(crate) capacity_in_bytes: ::std::option::Option<i64>,
}
impl OutpostBuilder {
    /// <p>Specifies the unique Amazon Resource Name (ARN) for the outpost.</p>
    pub fn outpost_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.outpost_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Specifies the unique Amazon Resource Name (ARN) for the outpost.</p>
    pub fn set_outpost_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.outpost_arn = input;
        self
    }
    /// <p>Specifies the unique Amazon Resource Name (ARN) for the outpost.</p>
    pub fn get_outpost_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.outpost_arn
    }
    /// <p>Specifies the unique S3 on Outposts ARN for use with Resource Access Manager (RAM).</p>
    pub fn s3_outpost_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.s3_outpost_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Specifies the unique S3 on Outposts ARN for use with Resource Access Manager (RAM).</p>
    pub fn set_s3_outpost_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.s3_outpost_arn = input;
        self
    }
    /// <p>Specifies the unique S3 on Outposts ARN for use with Resource Access Manager (RAM).</p>
    pub fn get_s3_outpost_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.s3_outpost_arn
    }
    /// <p>Specifies the unique identifier for the outpost.</p>
    pub fn outpost_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.outpost_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Specifies the unique identifier for the outpost.</p>
    pub fn set_outpost_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.outpost_id = input;
        self
    }
    /// <p>Specifies the unique identifier for the outpost.</p>
    pub fn get_outpost_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.outpost_id
    }
    /// <p>Returns the Amazon Web Services account ID of the outpost owner. Useful for comparing owned versus shared outposts.</p>
    pub fn owner_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.owner_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Returns the Amazon Web Services account ID of the outpost owner. Useful for comparing owned versus shared outposts.</p>
    pub fn set_owner_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.owner_id = input;
        self
    }
    /// <p>Returns the Amazon Web Services account ID of the outpost owner. Useful for comparing owned versus shared outposts.</p>
    pub fn get_owner_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.owner_id
    }
    /// <p>The Amazon S3 capacity of the outpost in bytes.</p>
    pub fn capacity_in_bytes(mut self, input: i64) -> Self {
        self.capacity_in_bytes = ::std::option::Option::Some(input);
        self
    }
    /// <p>The Amazon S3 capacity of the outpost in bytes.</p>
    pub fn set_capacity_in_bytes(mut self, input: ::std::option::Option<i64>) -> Self {
        self.capacity_in_bytes = input;
        self
    }
    /// <p>The Amazon S3 capacity of the outpost in bytes.</p>
    pub fn get_capacity_in_bytes(&self) -> &::std::option::Option<i64> {
        &self.capacity_in_bytes
    }
    /// Consumes the builder and constructs a [`Outpost`](crate::types::Outpost).
    pub fn build(self) -> crate::types::Outpost {
        crate::types::Outpost {
            outpost_arn: self.outpost_arn,
            s3_outpost_arn: self.s3_outpost_arn,
            outpost_id: self.outpost_id,
            owner_id: self.owner_id,
            capacity_in_bytes: self.capacity_in_bytes.unwrap_or_default(),
        }
    }
}