Package software.amazon.awssdk.services.efs.model

Class PutFileSystemPolicyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.efs.model.EfsRequest

software.amazon.awssdk.services.efs.model.PutFileSystemPolicyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutFileSystemPolicyRequest.Builder,PutFileSystemPolicyRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PutFileSystemPolicyRequest
extends EfsRequest
implements ToCopyableBuilder<PutFileSystemPolicyRequest.Builder,PutFileSystemPolicyRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutFileSystemPolicyRequest.Builder

Method Summary

Modifier and Type	Method	Description
static PutFileSystemPolicyRequest.Builder	builder()
Boolean	bypassPolicyLockoutSafetyCheck()	(Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy lockout safety check.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fileSystemId()	The ID of the EFS file system that you want to create or update the FileSystemPolicy for.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	policy()	The FileSystemPolicy that you're creating.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PutFileSystemPolicyRequest.Builder>	serializableBuilderClass()
PutFileSystemPolicyRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

fileSystemId

public final String fileSystemId()

The ID of the EFS file system that you want to create or update the FileSystemPolicy for.

Returns:

The ID of the EFS file system that you want to create or update the FileSystemPolicy for.

policy

public final String policy()

The FileSystemPolicy 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 Resource-based policies within Amazon EFS.

Returns:

The FileSystemPolicy 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 Resource-based policies within Amazon EFS.

bypassPolicyLockoutSafetyCheck

public final Boolean bypassPolicyLockoutSafetyCheck()

(Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy 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 PutFileSystemPolicy requests on this file system. Set BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the IAM principal that is making the request from making subsequent PutFileSystemPolicy requests on this file system. The default value is False.

Returns:

(Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy 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 PutFileSystemPolicy requests on this file system. Set BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the IAM principal that is making the request from making subsequent PutFileSystemPolicy requests on this file system. The default value is False.

toBuilder

public PutFileSystemPolicyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutFileSystemPolicyRequest.Builder,PutFileSystemPolicyRequest>

Specified by:

toBuilder in class EfsRequest

builder

public static PutFileSystemPolicyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutFileSystemPolicyRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo