View a markdown version of this page

AWS::Cases::Case - 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::Cases::Case

Note

If you provide a value for PerformedBy.UserArn, you must also have the connect:DescribeUser permission on the user ARN that you provide.

Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.

When creating a case from a template that has tag propagation configurations, the specified tags are automatically applied to the case.

The following field is always required when creating a case:

  • title

The following field may be required depending on the template configuration:

  • customer_id - Required only if the template's requiredFields list includes customer_id. When required, provide the full customer profile ARN in this format: arn:aws:profile:your_AWS_Region:your_AWS_account_ID:domains/your_profiles_domain_name/profiles/profile_ID. When not required, the field is optional and can be omitted, added, changed, or removed after case creation.

Syntax

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

JSON

{
  "Type" : "AWS::Cases::Case",
  "Properties" : {
      "CustomerId" : String,
      "DomainId" : String,
      "Tags" : [ Tag, ... ],
      "TemplateId" : String,
      "Title" : String
    }
}

YAML

Type: AWS::Cases::Case
Properties:
  CustomerId: String
  DomainId: String
  Tags: 
    - Tag
  TemplateId: String
  Title: String

Properties

CustomerId

Property description not available.

Required: Yes

Type: String

Maximum: 4100

Update requires: Replacement

DomainId

Property description not available.

Required: Yes

Type: String

Minimum: 1

Maximum: 500

Update requires: Replacement

Tags

A map of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

TemplateId

A unique identifier of a template.

Required: Yes

Type: String

Minimum: 1

Maximum: 500

Update requires: Replacement

Title

Property description not available.

Required: Yes

Type: String

Maximum: 4100

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

Property description not available.

CaseId

A unique identifier of the case.