Interface CreateDelegationRequestRequest.Builder

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

  • Method Details

    • ownerAccountId

      CreateDelegationRequestRequest.Builder ownerAccountId(String ownerAccountId)

      The Amazon Web Services account ID this delegation request is targeted to.

      If the account ID is not known, this parameter can be omitted, resulting in a request that can be associated by any account. If the account ID passed, then the created delegation request can only be associated with an identity of that target account.

      Parameters:
      ownerAccountId - The Amazon Web Services account ID this delegation request is targeted to.

      If the account ID is not known, this parameter can be omitted, resulting in a request that can be associated by any account. If the account ID passed, then the created delegation request can only be associated with an identity of that target account.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateDelegationRequestRequest.Builder description(String description)

      A description of the delegation request.

      Parameters:
      description - A description of the delegation request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permissions

      CreateDelegationRequestRequest.Builder permissions(DelegationPermission permissions)

      The permissions to be delegated in this delegation request.

      Parameters:
      permissions - The permissions to be delegated in this delegation request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permissions

      default CreateDelegationRequestRequest.Builder permissions(Consumer<DelegationPermission.Builder> permissions)

      The permissions to be delegated in this delegation request.

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

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

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

    • requestMessage

      CreateDelegationRequestRequest.Builder requestMessage(String requestMessage)

      A message explaining the reason for the delegation request.

      Requesters can utilize this field to add a custom note to the delegation request. This field is different from the description such that this is to be utilized for a custom messaging on a case-by-case basis.

      For example, if the current delegation request is in response to a previous request being rejected, this explanation can be added to the request via this field.

      Parameters:
      requestMessage - A message explaining the reason for the delegation request.

      Requesters can utilize this field to add a custom note to the delegation request. This field is different from the description such that this is to be utilized for a custom messaging on a case-by-case basis.

      For example, if the current delegation request is in response to a previous request being rejected, this explanation can be added to the request via this field.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requestorWorkflowId

      CreateDelegationRequestRequest.Builder requestorWorkflowId(String requestorWorkflowId)

      The workflow ID associated with the requestor.

      This is the unique identifier on the partner side that can be used to track the progress of the request.

      IAM maintains a uniqueness check on this workflow id for each request - if a workflow id for an existing request is passed, this API call will fail.

      Parameters:
      requestorWorkflowId - The workflow ID associated with the requestor.

      This is the unique identifier on the partner side that can be used to track the progress of the request.

      IAM maintains a uniqueness check on this workflow id for each request - if a workflow id for an existing request is passed, this API call will fail.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • redirectUrl

      CreateDelegationRequestRequest.Builder redirectUrl(String redirectUrl)

      The URL to redirect to after the delegation request is processed.

      This URL is used by the IAM console to show a link to the customer to re-load the partner workflow.

      Parameters:
      redirectUrl - The URL to redirect to after the delegation request is processed.

      This URL is used by the IAM console to show a link to the customer to re-load the partner workflow.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notificationChannel

      CreateDelegationRequestRequest.Builder notificationChannel(String notificationChannel)

      The notification channel for updates about the delegation request.

      At this time,only SNS topic ARNs are accepted for notification. This topic ARN must have a resource policy granting SNS:Publish permission to the IAM service principal (iam.amazonaws.com). See partner onboarding documentation for more details.

      Parameters:
      notificationChannel - The notification channel for updates about the delegation request.

      At this time,only SNS topic ARNs are accepted for notification. This topic ARN must have a resource policy granting SNS:Publish permission to the IAM service principal ( iam.amazonaws.com). See partner onboarding documentation for more details.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionDuration

      CreateDelegationRequestRequest.Builder sessionDuration(Integer sessionDuration)

      The duration for which the delegated session should remain active, in seconds.

      The active time window for the session starts when the customer calls the SendDelegationToken API.

      Parameters:
      sessionDuration - The duration for which the delegated session should remain active, in seconds.

      The active time window for the session starts when the customer calls the SendDelegationToken API.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • onlySendByOwner

      CreateDelegationRequestRequest.Builder onlySendByOwner(Boolean onlySendByOwner)

      Specifies whether the delegation token should only be sent by the owner.

      This flag prevents any party other than the owner from calling SendDelegationToken API for this delegation request. This behavior becomes useful when the delegation request owner needs to be present for subsequent partner interactions, but the delegation request was sent to a more privileged user for approval due to the owner lacking sufficient delegation permissions.

      Parameters:
      onlySendByOwner - Specifies whether the delegation token should only be sent by the owner.

      This flag prevents any party other than the owner from calling SendDelegationToken API for this delegation request. This behavior becomes useful when the delegation request owner needs to be present for subsequent partner interactions, but the delegation request was sent to a more privileged user for approval due to the owner lacking sufficient delegation permissions.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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