Class SubscriberResource
- java.lang.Object
-
- software.amazon.awssdk.services.securitylake.model.SubscriberResource
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<SubscriberResource.Builder,SubscriberResource>
@Generated("software.amazon.awssdk:codegen") public final class SubscriberResource extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SubscriberResource.Builder,SubscriberResource>
Provides details about the Amazon Security Lake account subscription. Subscribers are notified of new objects for a source as the data is written to your Amazon S3 bucket for Security Lake.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceSubscriberResource.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<AccessType>accessTypes()You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.List<String>accessTypesAsStrings()You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.static SubscriberResource.Builderbuilder()InstantcreatedAt()The date and time when the subscriber was created.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAccessTypes()For responses, this returns true if the service returned a value for the AccessTypes property.inthashCode()booleanhasSources()For responses, this returns true if the service returned a value for the Sources property.StringresourceShareArn()The Amazon Resource Name (ARN) which uniquely defines the Amazon Web Services RAM resource share.StringresourceShareName()The name of the resource share.StringroleArn()The Amazon Resource Name (ARN) specifying the role of the subscriber.Strings3BucketArn()The ARN for the Amazon S3 bucket.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends SubscriberResource.Builder>serializableBuilderClass()List<LogSourceResource>sources()Amazon Security Lake supports log and event collection for natively supported Amazon Web Services services.StringsubscriberArn()The subscriber ARN of the Amazon Security Lake subscriber account.StringsubscriberDescription()The subscriber descriptions for a subscriber account.StringsubscriberEndpoint()The subscriber endpoint to which exception messages are posted.StringsubscriberId()The subscriber ID of the Amazon Security Lake subscriber account.AwsIdentitysubscriberIdentity()The Amazon Web Services identity used to access your data.StringsubscriberName()The name of your Amazon Security Lake subscriber account.SubscriberStatussubscriberStatus()The subscriber status of the Amazon Security Lake subscriber account.StringsubscriberStatusAsString()The subscriber status of the Amazon Security Lake subscriber account.SubscriberResource.BuildertoBuilder()StringtoString()Returns a string representation of this object.InstantupdatedAt()The date and time when the subscriber was last updated.-
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
-
accessTypes
public final List<AccessType> accessTypes()
You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.
Subscribers can consume data by directly querying Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as
LAKEFORMATION.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
hasAccessTypes()method.- Returns:
- You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS)
queue or through messaging to an HTTPS endpoint provided by the subscriber.
Subscribers can consume data by directly querying Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as
LAKEFORMATION.
-
hasAccessTypes
public final boolean hasAccessTypes()
For responses, this returns true if the service returned a value for the AccessTypes 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.
-
accessTypesAsStrings
public final List<String> accessTypesAsStrings()
You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.
Subscribers can consume data by directly querying Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as
LAKEFORMATION.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
hasAccessTypes()method.- Returns:
- You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS)
queue or through messaging to an HTTPS endpoint provided by the subscriber.
Subscribers can consume data by directly querying Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as
LAKEFORMATION.
-
createdAt
public final Instant createdAt()
The date and time when the subscriber was created.
- Returns:
- The date and time when the subscriber was created.
-
resourceShareArn
public final String resourceShareArn()
The Amazon Resource Name (ARN) which uniquely defines the Amazon Web Services RAM resource share. Before accepting the RAM resource share invitation, you can view details related to the RAM resource share.
This field is available only for Lake Formation subscribers created after March 8, 2023.
- Returns:
- The Amazon Resource Name (ARN) which uniquely defines the Amazon Web Services RAM resource share. Before
accepting the RAM resource share invitation, you can view details related to the RAM resource share.
This field is available only for Lake Formation subscribers created after March 8, 2023.
-
resourceShareName
public final String resourceShareName()
The name of the resource share.
- Returns:
- The name of the resource share.
-
roleArn
public final String roleArn()
The Amazon Resource Name (ARN) specifying the role of the subscriber.
- Returns:
- The Amazon Resource Name (ARN) specifying the role of the subscriber.
-
s3BucketArn
public final String s3BucketArn()
The ARN for the Amazon S3 bucket.
- Returns:
- The ARN for the Amazon S3 bucket.
-
hasSources
public final boolean hasSources()
For responses, this returns true if the service returned a value for the Sources 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.
-
sources
public final List<LogSourceResource> sources()
Amazon Security Lake supports log and event collection for natively supported Amazon Web Services services. For more information, see the Amazon Security Lake User Guide.
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
hasSources()method.- Returns:
- Amazon Security Lake supports log and event collection for natively supported Amazon Web Services services. For more information, see the Amazon Security Lake User Guide.
-
subscriberArn
public final String subscriberArn()
The subscriber ARN of the Amazon Security Lake subscriber account.
- Returns:
- The subscriber ARN of the Amazon Security Lake subscriber account.
-
subscriberDescription
public final String subscriberDescription()
The subscriber descriptions for a subscriber account. The description for a subscriber includes
subscriberName,accountID,externalID, andsubscriberId.- Returns:
- The subscriber descriptions for a subscriber account. The description for a subscriber includes
subscriberName,accountID,externalID, andsubscriberId.
-
subscriberEndpoint
public final String subscriberEndpoint()
The subscriber endpoint to which exception messages are posted.
- Returns:
- The subscriber endpoint to which exception messages are posted.
-
subscriberId
public final String subscriberId()
The subscriber ID of the Amazon Security Lake subscriber account.
- Returns:
- The subscriber ID of the Amazon Security Lake subscriber account.
-
subscriberIdentity
public final AwsIdentity subscriberIdentity()
The Amazon Web Services identity used to access your data.
- Returns:
- The Amazon Web Services identity used to access your data.
-
subscriberName
public final String subscriberName()
The name of your Amazon Security Lake subscriber account.
- Returns:
- The name of your Amazon Security Lake subscriber account.
-
subscriberStatus
public final SubscriberStatus subscriberStatus()
The subscriber status of the Amazon Security Lake subscriber account.
If the service returns an enum value that is not available in the current SDK version,
subscriberStatuswill returnSubscriberStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsubscriberStatusAsString().- Returns:
- The subscriber status of the Amazon Security Lake subscriber account.
- See Also:
SubscriberStatus
-
subscriberStatusAsString
public final String subscriberStatusAsString()
The subscriber status of the Amazon Security Lake subscriber account.
If the service returns an enum value that is not available in the current SDK version,
subscriberStatuswill returnSubscriberStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsubscriberStatusAsString().- Returns:
- The subscriber status of the Amazon Security Lake subscriber account.
- See Also:
SubscriberStatus
-
updatedAt
public final Instant updatedAt()
The date and time when the subscriber was last updated.
- Returns:
- The date and time when the subscriber was last updated.
-
toBuilder
public SubscriberResource.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<SubscriberResource.Builder,SubscriberResource>
-
builder
public static SubscriberResource.Builder builder()
-
serializableBuilderClass
public static Class<? extends SubscriberResource.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-