View a markdown version of this page

AWS::Personalize::Campaign - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Personalize::Campaign

An object that describes the deployment of a solution version. For more information on campaigns, see CreateCampaign.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Personalize::Campaign",
  "Properties" : {
      "CampaignConfig" : CampaignConfig,
      "MinProvisionedTPS" : Integer,
      "Name" : String,
      "SolutionVersionArn" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Personalize::Campaign
Properties:
  CampaignConfig: 
    CampaignConfig
  MinProvisionedTPS: Integer
  Name: String
  SolutionVersionArn: String
  Tags: 
    - Tag

Properties

CampaignConfig

The configuration details of a campaign.

Required: No

Type: CampaignConfig

Update requires: No interruption

MinProvisionedTPS

Specifies the requested minimum provisioned transactions (recommendations) per second. 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.

Required: No

Type: Integer

Minimum: 1

Update requires: No interruption

Name

The name of the campaign.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*$

Minimum: 1

Maximum: 63

Update requires: Replacement

SolutionVersionArn

The Amazon Resource Name (ARN) of the solution version the campaign uses.

Required: Yes

Type: String

Pattern: arn:([a-z\d-]+):personalize:.*:.*:.+

Maximum: 256

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

CampaignArn

The Amazon Resource Name (ARN) of the campaign.

CreationDateTime

The date and time (in Unix format) that the campaign was created.

LastUpdatedDateTime

The date and time (in Unix format) that the campaign was last updated.

Status

The status of the campaign.

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS