Interface CreateAuthCodeRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, ConnectRequest.Builder, CopyableBuilder<CreateAuthCodeRequest.Builder,CreateAuthCodeRequest>, SdkBuilder<CreateAuthCodeRequest.Builder,CreateAuthCodeRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateAuthCodeRequest
@Mutable @NotThreadSafe public static interface CreateAuthCodeRequest.Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<CreateAuthCodeRequest.Builder,CreateAuthCodeRequest>

  • Method Details

    • instanceId

      CreateAuthCodeRequest.Builder instanceId(String instanceId)

      The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

      Parameters:
      instanceId - The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scope

      CreateAuthCodeRequest.Builder scope(AuthScope scope)

      The scope for the authorization code. Defines the permissions and access boundaries for the session.

      Parameters:
      scope - The scope for the authorization code. Defines the permissions and access boundaries for the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scope

      default CreateAuthCodeRequest.Builder scope(Consumer<AuthScope.Builder> scope)

      The scope for the authorization code. Defines the permissions and access boundaries for the session.

      This is a convenience method that creates an instance of the AuthScope.Builder avoiding the need to create one manually via AuthScope.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scope(AuthScope).

      Parameters:
      scope - a consumer that will call methods on AuthScope.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxSessionDurationMinutes

      CreateAuthCodeRequest.Builder maxSessionDurationMinutes(Integer maxSessionDurationMinutes)

      The maximum duration of the session, in minutes. Minimum value of 1440 (24 hours). Maximum value of 43200 (30 days). If no value is provided, the session will expire after 400 days.

      Parameters:
      maxSessionDurationMinutes - The maximum duration of the session, in minutes. Minimum value of 1440 (24 hours). Maximum value of 43200 (30 days). If no value is provided, the session will expire after 400 days.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionInactivityDurationMinutes

      CreateAuthCodeRequest.Builder sessionInactivityDurationMinutes(Integer sessionInactivityDurationMinutes)

      The duration of inactivity, in minutes, after which the session expires. Minimum value of 1440 (24 hours). Maximum value of 20160 (14 days).

      Parameters:
      sessionInactivityDurationMinutes - The duration of inactivity, in minutes, after which the session expires. Minimum value of 1440 (24 hours). Maximum value of 20160 (14 days).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateAuthCodeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateAuthCodeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.