Package software.amazon.awssdk.services.personalize.model

Interface CreateCampaignRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateCampaignRequest.Builder,CreateCampaignRequest>, PersonalizeRequest.Builder, SdkBuilder<CreateCampaignRequest.Builder,CreateCampaignRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateCampaignRequest
public static interface CreateCampaignRequest.Builder extends PersonalizeRequest.Builder, SdkPojo, CopyableBuilder<CreateCampaignRequest.Builder,CreateCampaignRequest>

  • Method Details

    • name

      CreateCampaignRequest.Builder name(String name)

      A name for the new campaign. The campaign name must be unique within your account.

      Parameters:
      name - A name for the new campaign. The campaign name must be unique within your account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • solutionVersionArn

      CreateCampaignRequest.Builder solutionVersionArn(String solutionVersionArn)

      The Amazon Resource Name (ARN) of the trained model to deploy with the campaign. To specify the latest solution version of your solution, specify the ARN of your solution in SolutionArn/$LATEST format. You must use this format if you set syncWithLatestSolutionVersion to True in the CampaignConfig.

      To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version.

      For more information about automatic campaign updates, see Enabling automatic campaign updates.

      Parameters:
      solutionVersionArn - The Amazon Resource Name (ARN) of the trained model to deploy with the campaign. To specify the latest solution version of your solution, specify the ARN of your solution in SolutionArn/$LATEST format. You must use this format if you set syncWithLatestSolutionVersion to True in the CampaignConfig.

      To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version.

      For more information about automatic campaign updates, see Enabling automatic campaign updates.

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

    • minProvisionedTPS

      CreateCampaignRequest.Builder minProvisionedTPS(Integer minProvisionedTPS)

      Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

      Parameters:
      minProvisionedTPS - Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • campaignConfig

      CreateCampaignRequest.Builder campaignConfig(CampaignConfig campaignConfig)

      The configuration details of a campaign.

      Parameters:
      campaignConfig - The configuration details of a campaign.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • campaignConfig

      default CreateCampaignRequest.Builder campaignConfig(Consumer<CampaignConfig.Builder> campaignConfig)

      The configuration details of a campaign.

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

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

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

    • tags

      CreateCampaignRequest.Builder tags(Collection<Tag> tags)

      A list of tags to apply to the campaign.

      Parameters:
      tags - A list of tags to apply to the campaign.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateCampaignRequest.Builder tags(Tag... tags)

      A list of tags to apply to the campaign.

      Parameters:
      tags - A list of tags to apply to the campaign.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateCampaignRequest.Builder tags(Consumer<Tag.Builder>... tags)

      A list of tags to apply to the campaign.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

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

    • overrideConfiguration

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

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