Class S3DataAccessAsset
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<S3DataAccessAsset.Builder,
S3DataAccessAsset>
The Amazon S3 data access that is the asset.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
bucket()
The Amazon S3 bucket hosting data to be shared in the S3 data access.static S3DataAccessAsset.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the KeyPrefixes property.final boolean
hasKeys()
For responses, this returns true if the service returned a value for the Keys property.final boolean
For responses, this returns true if the service returned a value for the KmsKeysToGrant property.The Amazon S3 bucket used for hosting shared data in the Amazon S3 data access.keys()
S3 keys made available using this asset.final List
<KmsKeyToGrant> List of AWS KMS CMKs (Key Management System Customer Managed Keys) and ARNs used to encrypt S3 objects being shared in this S3 Data Access asset.final String
The automatically-generated bucket-style alias for your Amazon S3 Access Point.final String
The ARN for your Amazon S3 Access Point.static Class
<? extends S3DataAccessAsset.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
bucket
The Amazon S3 bucket hosting data to be shared in the S3 data access.
- Returns:
- The Amazon S3 bucket hosting data to be shared in the S3 data access.
-
hasKeyPrefixes
public final boolean hasKeyPrefixes()For responses, this returns true if the service returned a value for the KeyPrefixes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
keyPrefixes
The Amazon S3 bucket used for hosting shared data in the Amazon S3 data access.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasKeyPrefixes()
method.- Returns:
- The Amazon S3 bucket used for hosting shared data in the Amazon S3 data access.
-
hasKeys
public final boolean hasKeys()For responses, this returns true if the service returned a value for the Keys property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
keys
S3 keys made available using this asset.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasKeys()
method.- Returns:
- S3 keys made available using this asset.
-
s3AccessPointAlias
The automatically-generated bucket-style alias for your Amazon S3 Access Point. Customers can access their entitled data using the S3 Access Point alias.
- Returns:
- The automatically-generated bucket-style alias for your Amazon S3 Access Point. Customers can access their entitled data using the S3 Access Point alias.
-
s3AccessPointArn
The ARN for your Amazon S3 Access Point. Customers can also access their entitled data using the S3 Access Point ARN.
- Returns:
- The ARN for your Amazon S3 Access Point. Customers can also access their entitled data using the S3 Access Point ARN.
-
hasKmsKeysToGrant
public final boolean hasKmsKeysToGrant()For responses, this returns true if the service returned a value for the KmsKeysToGrant property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
kmsKeysToGrant
List of AWS KMS CMKs (Key Management System Customer Managed Keys) and ARNs used to encrypt S3 objects being shared in this S3 Data Access asset. Providers must include all AWS KMS keys used to encrypt these shared S3 objects.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasKmsKeysToGrant()
method.- Returns:
- List of AWS KMS CMKs (Key Management System Customer Managed Keys) and ARNs used to encrypt S3 objects being shared in this S3 Data Access asset. Providers must include all AWS KMS keys used to encrypt these shared S3 objects.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<S3DataAccessAsset.Builder,
S3DataAccessAsset> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-