Package software.amazon.awssdk.services.sesv2.model

Class CreateTenantRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.sesv2.model.SesV2Request
software.amazon.awssdk.services.sesv2.model.CreateTenantRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateTenantRequest.Builder,CreateTenantRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateTenantRequest extends SesV2Request implements ToCopyableBuilder<CreateTenantRequest.Builder,CreateTenantRequest>

Represents a request to create a tenant.

Tenants are logical containers that group related SES resources together. Each tenant can have its own set of resources like email identities, configuration sets, and templates, along with reputation metrics and sending status. This helps isolate and manage email sending for different customers or business units within your Amazon SES API v2 account.

  • Method Details

    • tenantName

      public final String tenantName()

      The name of the tenant to create. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only.

      Returns:
      The name of the tenant to create. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      An array of objects that define the tags (keys and values) to associate with the tenant

      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 hasTags() method.

      Returns:
      An array of objects that define the tags (keys and values) to associate with the tenant

    • suppressionAttributes

      public final TenantSuppressionAttributes suppressionAttributes()

      An object that contains information about the suppression list preferences for the tenant. Use this to configure tenant-level suppression at creation time.

      Returns:
      An object that contains information about the suppression list preferences for the tenant. Use this to configure tenant-level suppression at creation time.

    • toBuilder

      public CreateTenantRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateTenantRequest.Builder,CreateTenantRequest>
      Specified by:
      toBuilder in class SesV2Request

    • builder

      public static CreateTenantRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateTenantRequest.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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo