Package software.amazon.awssdk.services.securitylake.model

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:

  • Method Details

    • 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 the isEmpty() 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 AWS 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 AWS 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 the isEmpty() 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. 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. 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, and subscriberId.

      Returns:
      The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName, accountID, externalID, and subscriberId.

    • 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 AWS identity used to access your data.

      Returns:
      The AWS 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, subscriberStatus will return SubscriberStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from subscriberStatusAsString().

      Returns:
      The subscriber status of the Amazon Security Lake subscriber account.
      See Also:

    • 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, subscriberStatus will return SubscriberStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from subscriberStatusAsString().

      Returns:
      The subscriber status of the Amazon Security Lake subscriber account.
      See Also:

    • 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()
      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 interface ToCopyableBuilder<SubscriberResource.Builder,SubscriberResource>
      Returns:
      a builder for type T

    • builder

      public static SubscriberResource.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SubscriberResource.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.