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(value="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 and Description
static interface	SubscriberResource.Builder

Method Summary

Modifier and Type	Method and 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.
String	accountId() The Amazon Web Services account ID you are using to create your Amazon Security Lake account.
static SubscriberResource.Builder	builder()
Instant	createdAt() The date and time when the subscription was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	externalId() The external ID of the subscriber.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAccessTypes() For responses, this returns true if the service returned a value for the AccessTypes property.
int	hashCode()
boolean	hasSourceTypes() For responses, this returns true if the service returned a value for the SourceTypes property.
String	resourceShareArn() The Amazon Resource Name (ARN) which uniquely defines the AWS RAM resource share.
String	resourceShareName() The name of the resource share.
String	roleArn() The Amazon Resource Name (ARN) specifying the role of the subscriber.
String	s3BucketArn() The ARN for the Amazon S3 bucket.
List<SdkField<?>>	sdkFields()
static Class<? extends SubscriberResource.Builder>	serializableBuilderClass()
String	snsArn() The ARN for the Amazon Simple Notification Service.
List<SourceType>	sourceTypes() Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.
String	subscriberDescription() The subscriber descriptions for a subscriber account.
String	subscriberName() The name of your Amazon Security Lake subscriber account.
String	subscriptionEndpoint() The subscription endpoint to which exception messages are posted.
String	subscriptionId() The subscription ID of the Amazon Security Lake subscriber account.
EndpointProtocol	subscriptionProtocol() The subscription protocol to which exception messages are posted.
String	subscriptionProtocolAsString() The subscription protocol to which exception messages are posted.
SubscriptionStatus	subscriptionStatus() The subscription status of the Amazon Security Lake subscriber account.
String	subscriptionStatusAsString() The subscription status of the Amazon Security Lake subscriber account.
SubscriberResource.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Instant	updatedAt() The date and time when the subscription was created.

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 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.

accountId

public final String accountId()

The Amazon Web Services account ID you are using to create your Amazon Security Lake account.

Returns:

The Amazon Web Services account ID you are using to create your Amazon Security Lake account.

createdAt

public final Instant createdAt()

The date and time when the subscription was created.

Returns:

The date and time when the subscription was created.

externalId

public final String externalId()

The external ID of the subscriber. The external ID lets the user that is assuming the role assert the circumstances in which they are operating. It also provides a way for the account owner to permit the role to be assumed only under specific circumstances.

Returns:

The external ID of the subscriber. The external ID lets the user that is assuming the role assert the circumstances in which they are operating. It also provides a way for the account owner to permit the role to be assumed only under specific circumstances.

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.

snsArn

public final String snsArn()

The ARN for the Amazon Simple Notification Service.

Returns:

The ARN for the Amazon Simple Notification Service.

hasSourceTypes

public final boolean hasSourceTypes()

For responses, this returns true if the service returned a value for the SourceTypes 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.

sourceTypes

public final List<SourceType> sourceTypes()

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 hasSourceTypes() 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.

subscriberDescription

public final String subscriberDescription()

The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName, accountID, externalID, and subscriptionId.

Returns:

The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName, accountID, externalID, and subscriptionId.

subscriberName

public final String subscriberName()

The name of your Amazon Security Lake subscriber account.

Returns:

The name of your Amazon Security Lake subscriber account.

subscriptionEndpoint

public final String subscriptionEndpoint()

The subscription endpoint to which exception messages are posted.

Returns:

The subscription endpoint to which exception messages are posted.

subscriptionId

public final String subscriptionId()

The subscription ID of the Amazon Security Lake subscriber account.

Returns:

The subscription ID of the Amazon Security Lake subscriber account.

subscriptionProtocol

public final EndpointProtocol subscriptionProtocol()

The subscription protocol to which exception messages are posted.

If the service returns an enum value that is not available in the current SDK version, subscriptionProtocol will return EndpointProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from subscriptionProtocolAsString().

Returns:

The subscription protocol to which exception messages are posted.

See Also:

EndpointProtocol

subscriptionProtocolAsString

public final String subscriptionProtocolAsString()

The subscription protocol to which exception messages are posted.

If the service returns an enum value that is not available in the current SDK version, subscriptionProtocol will return EndpointProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from subscriptionProtocolAsString().

Returns:

The subscription protocol to which exception messages are posted.

See Also:

EndpointProtocol

subscriptionStatus

public final SubscriptionStatus subscriptionStatus()

The subscription status of the Amazon Security Lake subscriber account.

If the service returns an enum value that is not available in the current SDK version, subscriptionStatus will return SubscriptionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from subscriptionStatusAsString().

Returns:

The subscription status of the Amazon Security Lake subscriber account.

See Also:

SubscriptionStatus

subscriptionStatusAsString

public final String subscriptionStatusAsString()

The subscription status of the Amazon Security Lake subscriber account.

If the service returns an enum value that is not available in the current SDK version, subscriptionStatus will return SubscriptionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from subscriptionStatusAsString().

Returns:

The subscription status of the Amazon Security Lake subscriber account.

See Also:

SubscriptionStatus

updatedAt

public final Instant updatedAt()

The date and time when the subscription was created.

Returns:

The date and time when the subscription was created.

toBuilder

public SubscriberResource.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SubscriberResource.Builder,SubscriberResource>

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)

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