Interface UpdateRcsAgentRequest.Builder

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

  • Method Details

    • rcsAgentId

      UpdateRcsAgentRequest.Builder rcsAgentId(String rcsAgentId)

      The unique identifier of the RCS agent to update. You can use either the RcsAgentId or RcsAgentArn.

      Parameters:
      rcsAgentId - The unique identifier of the RCS agent to update. You can use either the RcsAgentId or RcsAgentArn.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deletionProtectionEnabled

      UpdateRcsAgentRequest.Builder deletionProtectionEnabled(Boolean deletionProtectionEnabled)

      By default this is set to false. When set to true the RCS agent can't be deleted.

      Parameters:
      deletionProtectionEnabled - By default this is set to false. When set to true the RCS agent can't be deleted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • optOutListName

      UpdateRcsAgentRequest.Builder optOutListName(String optOutListName)

      The OptOutList to associate with the RCS agent. Valid values are either OptOutListName or OptOutListArn.

      Parameters:
      optOutListName - The OptOutList to associate with the RCS agent. Valid values are either OptOutListName or OptOutListArn.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • selfManagedOptOutsEnabled

      UpdateRcsAgentRequest.Builder selfManagedOptOutsEnabled(Boolean selfManagedOptOutsEnabled)

      By default this is set to false. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

      Parameters:
      selfManagedOptOutsEnabled - By default this is set to false. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • twoWayChannelArn

      UpdateRcsAgentRequest.Builder twoWayChannelArn(String twoWayChannelArn)

      The Amazon Resource Name (ARN) of the two way channel.

      Parameters:
      twoWayChannelArn - The Amazon Resource Name (ARN) of the two way channel.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • twoWayChannelRole

      UpdateRcsAgentRequest.Builder twoWayChannelRole(String twoWayChannelRole)

      An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

      Parameters:
      twoWayChannelRole - An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • twoWayEnabled

      UpdateRcsAgentRequest.Builder twoWayEnabled(Boolean twoWayEnabled)

      By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

      Parameters:
      twoWayEnabled - By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • twoWayMediaS3BucketName

      UpdateRcsAgentRequest.Builder twoWayMediaS3BucketName(String twoWayMediaS3BucketName)

      The name of the S3 bucket where inbound RCS media files are stored. Two-way messaging must be enabled on the agent. To remove the media configuration, pass the sentinel value UNSET_RCS_MEDIA_CONFIGURATION for both this field and TwoWayMediaS3Role.

      Parameters:
      twoWayMediaS3BucketName - The name of the S3 bucket where inbound RCS media files are stored. Two-way messaging must be enabled on the agent. To remove the media configuration, pass the sentinel value UNSET_RCS_MEDIA_CONFIGURATION for both this field and TwoWayMediaS3Role.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • twoWayMediaS3KeyPrefix

      UpdateRcsAgentRequest.Builder twoWayMediaS3KeyPrefix(String twoWayMediaS3KeyPrefix)

      The key prefix used for inbound RCS media objects in the S3 bucket.

      Parameters:
      twoWayMediaS3KeyPrefix - The key prefix used for inbound RCS media objects in the S3 bucket.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • twoWayMediaS3Role

      UpdateRcsAgentRequest.Builder twoWayMediaS3Role(String twoWayMediaS3Role)

      The ARN of the IAM role used to write inbound RCS media files to the S3 bucket. The role must have s3:PutObject permission on the bucket and a trust policy allowing sms-voice.amazonaws.com to assume it. To remove the media configuration, pass the sentinel value UNSET_RCS_MEDIA_CONFIGURATION for both this field and TwoWayMediaS3BucketName.

      Parameters:
      twoWayMediaS3Role - The ARN of the IAM role used to write inbound RCS media files to the S3 bucket. The role must have s3:PutObject permission on the bucket and a trust policy allowing sms-voice.amazonaws.com to assume it. To remove the media configuration, pass the sentinel value UNSET_RCS_MEDIA_CONFIGURATION for both this field and TwoWayMediaS3BucketName.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • twoWayRcsEventsEnabled

      UpdateRcsAgentRequest.Builder twoWayRcsEventsEnabled(Collection<String> twoWayRcsEventsEnabled)

      The list of RCS event types to enable for two-way messaging. Pass an empty list to disable all event types. The special value ALL enables all current and future event types and must be the sole element if used.

      Parameters:
      twoWayRcsEventsEnabled - The list of RCS event types to enable for two-way messaging. Pass an empty list to disable all event types. The special value ALL enables all current and future event types and must be the sole element if used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • twoWayRcsEventsEnabled

      UpdateRcsAgentRequest.Builder twoWayRcsEventsEnabled(String... twoWayRcsEventsEnabled)

      The list of RCS event types to enable for two-way messaging. Pass an empty list to disable all event types. The special value ALL enables all current and future event types and must be the sole element if used.

      Parameters:
      twoWayRcsEventsEnabled - The list of RCS event types to enable for two-way messaging. Pass an empty list to disable all event types. The special value ALL enables all current and future event types and must be the sole element if used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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