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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
// 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 CreateAccessGrantInput {
/// <p>The Amazon Web Services account ID of the S3 Access Grants instance.</p>
pub account_id: ::std::option::Option<::std::string::String>,
/// <p>The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID <code>default</code> to the default location <code>s3://</code> and assigns an auto-generated ID to other locations that you register.</p>
/// <p>If you are passing the <code>default</code> location, you cannot create an access grant for the entire default location. You must also specify a bucket or a bucket and prefix in the <code>Subprefix</code> field.</p>
pub access_grants_location_id: ::std::option::Option<::std::string::String>,
/// <p>The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access. It contains the <code>S3SubPrefix</code> field. The grant scope is the result of appending the subprefix to the location scope of the registered location.</p>
pub access_grants_location_configuration: ::std::option::Option<crate::types::AccessGrantsLocationConfiguration>,
/// <p>The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.</p>
pub grantee: ::std::option::Option<crate::types::Grantee>,
/// <p>The type of access that you are granting to your S3 data, which can be set to one of the following values:</p>
/// <ul>
/// <li>
/// <p><code>READ</code> – Grant read-only access to the S3 data.</p></li>
/// <li>
/// <p><code>WRITE</code> – Grant write-only access to the S3 data.</p></li>
/// <li>
/// <p><code>READWRITE</code> – Grant both read and write access to the S3 data.</p></li>
/// </ul>
pub permission: ::std::option::Option<crate::types::Permission>,
/// <p>The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If an application ARN is included in the request to create an access grant, the grantee can only access the S3 data through this application.</p>
pub application_arn: ::std::option::Option<::std::string::String>,
/// <p>The type of <code>S3SubPrefix</code>. The only possible value is <code>Object</code>. Pass this value if the access grant scope is an object. Do not pass this value if the access grant scope is a bucket or a bucket and a prefix.</p>
pub s3_prefix_type: ::std::option::Option<crate::types::S3PrefixType>,
/// <p>The Amazon Web Services resource tags that you are adding to the access grant. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.</p>
pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl CreateAccessGrantInput {
/// <p>The Amazon Web Services account ID of the S3 Access Grants instance.</p>
pub fn account_id(&self) -> ::std::option::Option<&str> {
self.account_id.as_deref()
}
/// <p>The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID <code>default</code> to the default location <code>s3://</code> and assigns an auto-generated ID to other locations that you register.</p>
/// <p>If you are passing the <code>default</code> location, you cannot create an access grant for the entire default location. You must also specify a bucket or a bucket and prefix in the <code>Subprefix</code> field.</p>
pub fn access_grants_location_id(&self) -> ::std::option::Option<&str> {
self.access_grants_location_id.as_deref()
}
/// <p>The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access. It contains the <code>S3SubPrefix</code> field. The grant scope is the result of appending the subprefix to the location scope of the registered location.</p>
pub fn access_grants_location_configuration(&self) -> ::std::option::Option<&crate::types::AccessGrantsLocationConfiguration> {
self.access_grants_location_configuration.as_ref()
}
/// <p>The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.</p>
pub fn grantee(&self) -> ::std::option::Option<&crate::types::Grantee> {
self.grantee.as_ref()
}
/// <p>The type of access that you are granting to your S3 data, which can be set to one of the following values:</p>
/// <ul>
/// <li>
/// <p><code>READ</code> – Grant read-only access to the S3 data.</p></li>
/// <li>
/// <p><code>WRITE</code> – Grant write-only access to the S3 data.</p></li>
/// <li>
/// <p><code>READWRITE</code> – Grant both read and write access to the S3 data.</p></li>
/// </ul>
pub fn permission(&self) -> ::std::option::Option<&crate::types::Permission> {
self.permission.as_ref()
}
/// <p>The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If an application ARN is included in the request to create an access grant, the grantee can only access the S3 data through this application.</p>
pub fn application_arn(&self) -> ::std::option::Option<&str> {
self.application_arn.as_deref()
}
/// <p>The type of <code>S3SubPrefix</code>. The only possible value is <code>Object</code>. Pass this value if the access grant scope is an object. Do not pass this value if the access grant scope is a bucket or a bucket and a prefix.</p>
pub fn s3_prefix_type(&self) -> ::std::option::Option<&crate::types::S3PrefixType> {
self.s3_prefix_type.as_ref()
}
/// <p>The Amazon Web Services resource tags that you are adding to the access grant. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.</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 CreateAccessGrantInput {
/// Creates a new builder-style object to manufacture [`CreateAccessGrantInput`](crate::operation::create_access_grant::CreateAccessGrantInput).
pub fn builder() -> crate::operation::create_access_grant::builders::CreateAccessGrantInputBuilder {
crate::operation::create_access_grant::builders::CreateAccessGrantInputBuilder::default()
}
}
/// A builder for [`CreateAccessGrantInput`](crate::operation::create_access_grant::CreateAccessGrantInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreateAccessGrantInputBuilder {
pub(crate) account_id: ::std::option::Option<::std::string::String>,
pub(crate) access_grants_location_id: ::std::option::Option<::std::string::String>,
pub(crate) access_grants_location_configuration: ::std::option::Option<crate::types::AccessGrantsLocationConfiguration>,
pub(crate) grantee: ::std::option::Option<crate::types::Grantee>,
pub(crate) permission: ::std::option::Option<crate::types::Permission>,
pub(crate) application_arn: ::std::option::Option<::std::string::String>,
pub(crate) s3_prefix_type: ::std::option::Option<crate::types::S3PrefixType>,
pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl CreateAccessGrantInputBuilder {
/// <p>The Amazon Web Services account ID of the S3 Access Grants instance.</p>
/// This field is required.
pub fn account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.account_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon Web Services account ID of the S3 Access Grants instance.</p>
pub fn set_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.account_id = input;
self
}
/// <p>The Amazon Web Services account ID of the S3 Access Grants instance.</p>
pub fn get_account_id(&self) -> &::std::option::Option<::std::string::String> {
&self.account_id
}
/// <p>The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID <code>default</code> to the default location <code>s3://</code> and assigns an auto-generated ID to other locations that you register.</p>
/// <p>If you are passing the <code>default</code> location, you cannot create an access grant for the entire default location. You must also specify a bucket or a bucket and prefix in the <code>Subprefix</code> field.</p>
/// This field is required.
pub fn access_grants_location_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.access_grants_location_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID <code>default</code> to the default location <code>s3://</code> and assigns an auto-generated ID to other locations that you register.</p>
/// <p>If you are passing the <code>default</code> location, you cannot create an access grant for the entire default location. You must also specify a bucket or a bucket and prefix in the <code>Subprefix</code> field.</p>
pub fn set_access_grants_location_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.access_grants_location_id = input;
self
}
/// <p>The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID <code>default</code> to the default location <code>s3://</code> and assigns an auto-generated ID to other locations that you register.</p>
/// <p>If you are passing the <code>default</code> location, you cannot create an access grant for the entire default location. You must also specify a bucket or a bucket and prefix in the <code>Subprefix</code> field.</p>
pub fn get_access_grants_location_id(&self) -> &::std::option::Option<::std::string::String> {
&self.access_grants_location_id
}
/// <p>The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access. It contains the <code>S3SubPrefix</code> field. The grant scope is the result of appending the subprefix to the location scope of the registered location.</p>
pub fn access_grants_location_configuration(mut self, input: crate::types::AccessGrantsLocationConfiguration) -> Self {
self.access_grants_location_configuration = ::std::option::Option::Some(input);
self
}
/// <p>The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access. It contains the <code>S3SubPrefix</code> field. The grant scope is the result of appending the subprefix to the location scope of the registered location.</p>
pub fn set_access_grants_location_configuration(mut self, input: ::std::option::Option<crate::types::AccessGrantsLocationConfiguration>) -> Self {
self.access_grants_location_configuration = input;
self
}
/// <p>The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access. It contains the <code>S3SubPrefix</code> field. The grant scope is the result of appending the subprefix to the location scope of the registered location.</p>
pub fn get_access_grants_location_configuration(&self) -> &::std::option::Option<crate::types::AccessGrantsLocationConfiguration> {
&self.access_grants_location_configuration
}
/// <p>The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.</p>
/// This field is required.
pub fn grantee(mut self, input: crate::types::Grantee) -> Self {
self.grantee = ::std::option::Option::Some(input);
self
}
/// <p>The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.</p>
pub fn set_grantee(mut self, input: ::std::option::Option<crate::types::Grantee>) -> Self {
self.grantee = input;
self
}
/// <p>The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.</p>
pub fn get_grantee(&self) -> &::std::option::Option<crate::types::Grantee> {
&self.grantee
}
/// <p>The type of access that you are granting to your S3 data, which can be set to one of the following values:</p>
/// <ul>
/// <li>
/// <p><code>READ</code> – Grant read-only access to the S3 data.</p></li>
/// <li>
/// <p><code>WRITE</code> – Grant write-only access to the S3 data.</p></li>
/// <li>
/// <p><code>READWRITE</code> – Grant both read and write access to the S3 data.</p></li>
/// </ul>
/// This field is required.
pub fn permission(mut self, input: crate::types::Permission) -> Self {
self.permission = ::std::option::Option::Some(input);
self
}
/// <p>The type of access that you are granting to your S3 data, which can be set to one of the following values:</p>
/// <ul>
/// <li>
/// <p><code>READ</code> – Grant read-only access to the S3 data.</p></li>
/// <li>
/// <p><code>WRITE</code> – Grant write-only access to the S3 data.</p></li>
/// <li>
/// <p><code>READWRITE</code> – Grant both read and write access to the S3 data.</p></li>
/// </ul>
pub fn set_permission(mut self, input: ::std::option::Option<crate::types::Permission>) -> Self {
self.permission = input;
self
}
/// <p>The type of access that you are granting to your S3 data, which can be set to one of the following values:</p>
/// <ul>
/// <li>
/// <p><code>READ</code> – Grant read-only access to the S3 data.</p></li>
/// <li>
/// <p><code>WRITE</code> – Grant write-only access to the S3 data.</p></li>
/// <li>
/// <p><code>READWRITE</code> – Grant both read and write access to the S3 data.</p></li>
/// </ul>
pub fn get_permission(&self) -> &::std::option::Option<crate::types::Permission> {
&self.permission
}
/// <p>The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If an application ARN is included in the request to create an access grant, the grantee can only access the S3 data through this application.</p>
pub fn application_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.application_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If an application ARN is included in the request to create an access grant, the grantee can only access the S3 data through this application.</p>
pub fn set_application_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.application_arn = input;
self
}
/// <p>The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If an application ARN is included in the request to create an access grant, the grantee can only access the S3 data through this application.</p>
pub fn get_application_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.application_arn
}
/// <p>The type of <code>S3SubPrefix</code>. The only possible value is <code>Object</code>. Pass this value if the access grant scope is an object. Do not pass this value if the access grant scope is a bucket or a bucket and a prefix.</p>
pub fn s3_prefix_type(mut self, input: crate::types::S3PrefixType) -> Self {
self.s3_prefix_type = ::std::option::Option::Some(input);
self
}
/// <p>The type of <code>S3SubPrefix</code>. The only possible value is <code>Object</code>. Pass this value if the access grant scope is an object. Do not pass this value if the access grant scope is a bucket or a bucket and a prefix.</p>
pub fn set_s3_prefix_type(mut self, input: ::std::option::Option<crate::types::S3PrefixType>) -> Self {
self.s3_prefix_type = input;
self
}
/// <p>The type of <code>S3SubPrefix</code>. The only possible value is <code>Object</code>. Pass this value if the access grant scope is an object. Do not pass this value if the access grant scope is a bucket or a bucket and a prefix.</p>
pub fn get_s3_prefix_type(&self) -> &::std::option::Option<crate::types::S3PrefixType> {
&self.s3_prefix_type
}
/// Appends an item to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>The Amazon Web Services resource tags that you are adding to the access grant. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.</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 Amazon Web Services resource tags that you are adding to the access grant. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.</p>
pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
self.tags = input;
self
}
/// <p>The Amazon Web Services resource tags that you are adding to the access grant. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.</p>
pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
&self.tags
}
/// Consumes the builder and constructs a [`CreateAccessGrantInput`](crate::operation::create_access_grant::CreateAccessGrantInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::create_access_grant::CreateAccessGrantInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::create_access_grant::CreateAccessGrantInput {
account_id: self.account_id,
access_grants_location_id: self.access_grants_location_id,
access_grants_location_configuration: self.access_grants_location_configuration,
grantee: self.grantee,
permission: self.permission,
application_arn: self.application_arn,
s3_prefix_type: self.s3_prefix_type,
tags: self.tags,
})
}
}