software.amazon.awssdk.services.securitylake.model

Class CreateSubscriberRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.securitylake.model.SecurityLakeRequest

software.amazon.awssdk.services.securitylake.model.CreateSubscriberRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateSubscriberRequest.Builder,CreateSubscriberRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateSubscriberRequest
extends SecurityLakeRequest
implements ToCopyableBuilder<CreateSubscriberRequest.Builder,CreateSubscriberRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateSubscriberRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<AccessType>	accessTypes() The Amazon S3 or Lake Formation access type.
List<String>	accessTypesAsStrings() The Amazon S3 or Lake Formation access type.
String	accountId() The Amazon Web Services account ID used to access your data.
static CreateSubscriberRequest.Builder	builder()
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.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateSubscriberRequest.Builder>	serializableBuilderClass()
List<SourceType>	sourceTypes() The supported Amazon Web Services from which logs and events are collected.
String	subscriberDescription() The description for your subscriber account in Security Lake.
String	subscriberName() The name of your Security Lake subscriber account.
CreateSubscriberRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

The Amazon S3 or Lake Formation access type.

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:

The Amazon S3 or Lake Formation access type.

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

The Amazon S3 or Lake Formation access type.

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:

The Amazon S3 or Lake Formation access type.

accountId

public final String accountId()

The Amazon Web Services account ID used to access your data.

Returns:

The Amazon Web Services account ID used to access your data.

externalId

public final String externalId()

The external ID of the subscriber. This 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. This 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.

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

The supported Amazon Web Services from which logs and events are collected. Security Lake supports log and event collection for natively supported Amazon Web Services.

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:

The supported Amazon Web Services from which logs and events are collected. Security Lake supports log and event collection for natively supported Amazon Web Services.

subscriberDescription

public final String subscriberDescription()

The description for your subscriber account in Security Lake.

Returns:

The description for your subscriber account in Security Lake.

subscriberName

public final String subscriberName()

The name of your Security Lake subscriber account.

Returns:

The name of your Security Lake subscriber account.

toBuilder

public CreateSubscriberRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateSubscriberRequest.Builder,CreateSubscriberRequest>

Specified by:

toBuilder in class SecurityLakeRequest

builder

public static CreateSubscriberRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo