Class CreateDelegationRequestRequest

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

  • Method Details

    • ownerAccountId

      public final 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.

      Returns:
      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.

    • description

      public final String description()

      A description of the delegation request.

      Returns:
      A description of the delegation request.

    • permissions

      public final DelegationPermission permissions()

      The permissions to be delegated in this delegation request.

      Returns:
      The permissions to be delegated in this delegation request.

    • requestMessage

      public final 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.

      Returns:
      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.

    • requestorWorkflowId

      public final 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.

      Returns:
      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.

    • redirectUrl

      public final 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.

      Returns:
      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.

    • notificationChannel

      public final 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.

      Returns:
      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.

    • sessionDuration

      public final 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.

      Returns:
      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.

    • onlySendByOwner

      public final 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.

      Returns:
      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.

    • toBuilder

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

    • builder

      public static CreateDelegationRequestRequest.Builder builder()

    • serializableBuilderClass

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