Package software.amazon.awssdk.services.s3control.model

Class AccessGrantsLocationConfiguration

java.lang.Object

software.amazon.awssdk.services.s3control.model.AccessGrantsLocationConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AccessGrantsLocationConfiguration.Builder,AccessGrantsLocationConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class AccessGrantsLocationConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AccessGrantsLocationConfiguration.Builder,AccessGrantsLocationConfiguration>

The configuration options of the S3 Access Grants location. It contains the S3SubPrefix field. The grant scope, the data to which you are granting access, is the result of appending the Subprefix field to the scope of the registered location.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AccessGrantsLocationConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static AccessGrantsLocationConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	s3SubPrefix()	The S3SubPrefix is appended to the location scope creating the grant scope.
List<SdkField<?>>	sdkFields()
static Class<? extends AccessGrantsLocationConfiguration.Builder>	serializableBuilderClass()
AccessGrantsLocationConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

s3SubPrefix

public final String s3SubPrefix()

The S3SubPrefix is appended to the location scope creating the grant scope. Use this field to narrow the scope of the grant to a subset of the location scope. This field is required if the location scope is the default location s3:// because you cannot create a grant for all of your S3 data in the Region and must narrow the scope. For example, if the location scope is the default location s3://, the S3SubPrefx can be a <bucket-name>/*, so the full grant scope path would be s3://<bucket-name>/*. Or the S3SubPrefx can be <bucket-name>/<prefix-name>*, so the full grant scope path would be or s3://<bucket-name>/<prefix-name>*.

If the S3SubPrefix includes a prefix, append the wildcard character * after the prefix to indicate that you want to include all object key names in the bucket that start with that prefix.

Returns:

The S3SubPrefix is appended to the location scope creating the grant scope. Use this field to narrow the scope of the grant to a subset of the location scope. This field is required if the location scope is the default location s3:// because you cannot create a grant for all of your S3 data in the Region and must narrow the scope. For example, if the location scope is the default location s3://, the S3SubPrefx can be a <bucket-name>/*, so the full grant scope path would be s3://<bucket-name>/*. Or the S3SubPrefx can be <bucket-name>/<prefix-name>*, so the full grant scope path would be or s3://<bucket-name>/<prefix-name>*.

If the S3SubPrefix includes a prefix, append the wildcard character * after the prefix to indicate that you want to include all object key names in the bucket that start with that prefix.

toBuilder

public AccessGrantsLocationConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AccessGrantsLocationConfiguration.Builder,AccessGrantsLocationConfiguration>

builder

public static AccessGrantsLocationConfiguration.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo