Class CreateApplicationRequest

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

  • Method Details

    • displayName

      public final String displayName()

      A name for the Amazon Q Business application.

      Returns:
      A name for the Amazon Q Business application.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a service linked role (SLR) and use it as the application's role.

      Returns:
      The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a service linked role (SLR) and use it as the application's role.

    • identityType

      public final IdentityType identityType()

      The authentication type being used by a Amazon Q Business application.

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

      Returns:
      The authentication type being used by a Amazon Q Business application.
      See Also:

    • identityTypeAsString

      public final String identityTypeAsString()

      The authentication type being used by a Amazon Q Business application.

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

      Returns:
      The authentication type being used by a Amazon Q Business application.
      See Also:

    • iamIdentityProviderArn

      public final String iamIdentityProviderArn()

      The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.

      Returns:
      The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.

    • identityCenterInstanceArn

      public final String identityCenterInstanceArn()

      The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.

      Returns:
      The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.

    • hasClientIdsForOIDC

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

    • clientIdsForOIDC

      public final List<String> clientIdsForOIDC()

      The OIDC client ID for a Amazon Q Business application.

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

      Returns:
      The OIDC client ID for a Amazon Q Business application.

    • description

      public final String description()

      A description for the Amazon Q Business application.

      Returns:
      A description for the Amazon Q Business application.

    • encryptionConfiguration

      public final EncryptionConfiguration encryptionConfiguration()

      The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.

      Returns:
      The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.

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

      A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

      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:
      A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

    • clientToken

      public final String clientToken()

      A token that you provide to identify the request to create your Amazon Q Business application.

      Returns:
      A token that you provide to identify the request to create your Amazon Q Business application.

    • attachmentsConfiguration

      public final AttachmentsConfiguration attachmentsConfiguration()

      An option to allow end users to upload files directly during chat.

      Returns:
      An option to allow end users to upload files directly during chat.

    • qAppsConfiguration

      public final QAppsConfiguration qAppsConfiguration()

      An option to allow end users to create and use Amazon Q Apps in the web experience.

      Returns:
      An option to allow end users to create and use Amazon Q Apps in the web experience.

    • personalizationConfiguration

      public final PersonalizationConfiguration personalizationConfiguration()

      Configuration information about chat response personalization. For more information, see Personalizing chat responses

      Returns:
      Configuration information about chat response personalization. For more information, see Personalizing chat responses

    • quickSightConfiguration

      public final QuickSightConfiguration quickSightConfiguration()

      The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight for authentication. This configuration is required if your application uses QuickSight as the identity provider. For more information, see Creating an Amazon QuickSight integrated application.

      Returns:
      The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight for authentication. This configuration is required if your application uses QuickSight as the identity provider. For more information, see Creating an Amazon QuickSight integrated application.

    • toBuilder

      public CreateApplicationRequest.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<CreateApplicationRequest.Builder,CreateApplicationRequest>
      Specified by:
      toBuilder in class QBusinessRequest
      Returns:
      a builder for type T

    • builder

      public static CreateApplicationRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateApplicationRequest.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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.