aws_sdk_efs/client/
put_file_system_policy.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`PutFileSystemPolicy`](crate::operation::put_file_system_policy::builders::PutFileSystemPolicyFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`file_system_id(impl Into<String>)`](crate::operation::put_file_system_policy::builders::PutFileSystemPolicyFluentBuilder::file_system_id) / [`set_file_system_id(Option<String>)`](crate::operation::put_file_system_policy::builders::PutFileSystemPolicyFluentBuilder::set_file_system_id):<br>required: **true**<br><p>The ID of the EFS file system that you want to create or update the <code>FileSystemPolicy</code> for.</p><br>
7    ///   - [`policy(impl Into<String>)`](crate::operation::put_file_system_policy::builders::PutFileSystemPolicyFluentBuilder::policy) / [`set_policy(Option<String>)`](crate::operation::put_file_system_policy::builders::PutFileSystemPolicyFluentBuilder::set_policy):<br>required: **true**<br><p>The <code>FileSystemPolicy</code> that you're creating. Accepts a JSON formatted policy definition. EFS file system policies have a 20,000 character limit. To find out more about the elements that make up a file system policy, see <a href="https://docs.aws.amazon.com/efs/latest/ug/security_iam_service-with-iam.html#security_iam_service-with-iam-resource-based-policies">Resource-based policies within Amazon EFS</a>.</p><br>
8    ///   - [`bypass_policy_lockout_safety_check(bool)`](crate::operation::put_file_system_policy::builders::PutFileSystemPolicyFluentBuilder::bypass_policy_lockout_safety_check) / [`set_bypass_policy_lockout_safety_check(Option<bool>)`](crate::operation::put_file_system_policy::builders::PutFileSystemPolicyFluentBuilder::set_bypass_policy_lockout_safety_check):<br>required: **false**<br><p>(Optional) A boolean that specifies whether or not to bypass the <code>FileSystemPolicy</code> lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future <code>PutFileSystemPolicy</code> requests on this file system. Set <code>BypassPolicyLockoutSafetyCheck</code> to <code>True</code> only when you intend to prevent the IAM principal that is making the request from making subsequent <code>PutFileSystemPolicy</code> requests on this file system. The default value is <code>False</code>.</p><br>
9    /// - On success, responds with [`PutFileSystemPolicyOutput`](crate::operation::put_file_system_policy::PutFileSystemPolicyOutput) with field(s):
10    ///   - [`file_system_id(Option<String>)`](crate::operation::put_file_system_policy::PutFileSystemPolicyOutput::file_system_id): <p>Specifies the EFS file system to which the <code>FileSystemPolicy</code> applies.</p>
11    ///   - [`policy(Option<String>)`](crate::operation::put_file_system_policy::PutFileSystemPolicyOutput::policy): <p>The JSON formatted <code>FileSystemPolicy</code> for the EFS file system.</p>
12    /// - On failure, responds with [`SdkError<PutFileSystemPolicyError>`](crate::operation::put_file_system_policy::PutFileSystemPolicyError)
13    pub fn put_file_system_policy(&self) -> crate::operation::put_file_system_policy::builders::PutFileSystemPolicyFluentBuilder {
14        crate::operation::put_file_system_policy::builders::PutFileSystemPolicyFluentBuilder::new(self.handle.clone())
15    }
16}