1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cases
  5. Template

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.44.0 published on Friday, Dec 19, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.cases.Template

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.44.0 published on Friday, Dec 19, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    A template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs.

    Create Template Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Template(name: string, args?: TemplateArgs, opts?: CustomResourceOptions);
    @overload
def Template(resource_name: str,
             args: Optional[TemplateArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def Template(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             description: Optional[str] = None,
             domain_id: Optional[str] = None,
             layout_configuration: Optional[TemplateLayoutConfigurationArgs] = None,
             name: Optional[str] = None,
             required_fields: Optional[Sequence[TemplateRequiredFieldArgs]] = None,
             rules: Optional[Sequence[TemplateRuleArgs]] = None,
             status: Optional[TemplateStatus] = None,
             tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewTemplate(ctx *Context, name string, args *TemplateArgs, opts ...ResourceOption) (*Template, error)
    public Template(string name, TemplateArgs? args = null, CustomResourceOptions? opts = null)
    public Template(String name, TemplateArgs args)
public Template(String name, TemplateArgs args, CustomResourceOptions options)

    type: aws-native:cases:Template
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args TemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TemplateArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TemplateArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Template Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Template resource accepts the following input properties:

    Description string
    A description explaining the purpose and use case for this template. Should indicate what types of cases this template is designed for and any specific workflow it supports.
    DomainId string
    The unique identifier of the Cases domain.
    LayoutConfiguration Pulumi.AwsNative.Cases.Inputs.TemplateLayoutConfiguration
    Name string
    A name for the template. It must be unique per domain.
    RequiredFields List<Pulumi.AwsNative.Cases.Inputs.TemplateRequiredField>
    A list of fields that must contain a value for a case to be successfully created with this template.
    Rules List<Pulumi.AwsNative.Cases.Inputs.TemplateRule>
    A list of case rules (also known as case field conditions) on a template.
    Status Pulumi.AwsNative.Cases.TemplateStatus
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The tags that you attach to this template.
    Description string
    A description explaining the purpose and use case for this template. Should indicate what types of cases this template is designed for and any specific workflow it supports.
    DomainId string
    The unique identifier of the Cases domain.
    LayoutConfiguration TemplateLayoutConfigurationArgs
    Name string
    A name for the template. It must be unique per domain.
    RequiredFields []TemplateRequiredFieldArgs
    A list of fields that must contain a value for a case to be successfully created with this template.
    Rules []TemplateRuleArgs
    A list of case rules (also known as case field conditions) on a template.
    Status TemplateStatus
    Tags TagArgs
    The tags that you attach to this template.
    description String
    A description explaining the purpose and use case for this template. Should indicate what types of cases this template is designed for and any specific workflow it supports.
    domainId String
    The unique identifier of the Cases domain.
    layoutConfiguration TemplateLayoutConfiguration
    name String
    A name for the template. It must be unique per domain.
    requiredFields List<TemplateRequiredField>
    A list of fields that must contain a value for a case to be successfully created with this template.
    rules List<TemplateRule>
    A list of case rules (also known as case field conditions) on a template.
    status TemplateStatus
    tags List<Tag>
    The tags that you attach to this template.
    description string
    A description explaining the purpose and use case for this template. Should indicate what types of cases this template is designed for and any specific workflow it supports.
    domainId string
    The unique identifier of the Cases domain.
    layoutConfiguration TemplateLayoutConfiguration
    name string
    A name for the template. It must be unique per domain.
    requiredFields TemplateRequiredField[]
    A list of fields that must contain a value for a case to be successfully created with this template.
    rules TemplateRule[]
    A list of case rules (also known as case field conditions) on a template.
    status TemplateStatus
    tags Tag[]
    The tags that you attach to this template.
    description str
    A description explaining the purpose and use case for this template. Should indicate what types of cases this template is designed for and any specific workflow it supports.
    domain_id str
    The unique identifier of the Cases domain.
    layout_configuration TemplateLayoutConfigurationArgs
    name str
    A name for the template. It must be unique per domain.
    required_fields Sequence[TemplateRequiredFieldArgs]
    A list of fields that must contain a value for a case to be successfully created with this template.
    rules Sequence[TemplateRuleArgs]
    A list of case rules (also known as case field conditions) on a template.
    status TemplateStatus
    tags Sequence[TagArgs]
    The tags that you attach to this template.
    description String
    A description explaining the purpose and use case for this template. Should indicate what types of cases this template is designed for and any specific workflow it supports.
    domainId String
    The unique identifier of the Cases domain.
    layoutConfiguration Property Map
    name String
    A name for the template. It must be unique per domain.
    requiredFields List<Property Map>
    A list of fields that must contain a value for a case to be successfully created with this template.
    rules List<Property Map>
    A list of case rules (also known as case field conditions) on a template.
    status "Active" | "Inactive"
    tags List<Property Map>
    The tags that you attach to this template.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Template resource produces the following output properties:

    CreatedTime string
    The time at which the template was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedTime string
    The time at which the template was created or last modified.
    TemplateArn string
    The Amazon Resource Name (ARN) of the template.
    TemplateId string
    The unique identifier of a template.
    CreatedTime string
    The time at which the template was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedTime string
    The time at which the template was created or last modified.
    TemplateArn string
    The Amazon Resource Name (ARN) of the template.
    TemplateId string
    The unique identifier of a template.
    createdTime String
    The time at which the template was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime String
    The time at which the template was created or last modified.
    templateArn String
    The Amazon Resource Name (ARN) of the template.
    templateId String
    The unique identifier of a template.
    createdTime string
    The time at which the template was created.
    id string
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime string
    The time at which the template was created or last modified.
    templateArn string
    The Amazon Resource Name (ARN) of the template.
    templateId string
    The unique identifier of a template.
    created_time str
    The time at which the template was created.
    id str
    The provider-assigned unique ID for this managed resource.
    last_modified_time str
    The time at which the template was created or last modified.
    template_arn str
    The Amazon Resource Name (ARN) of the template.
    template_id str
    The unique identifier of a template.
    createdTime String
    The time at which the template was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime String
    The time at which the template was created or last modified.
    templateArn String
    The Amazon Resource Name (ARN) of the template.
    templateId String
    The unique identifier of a template.

    Supporting Types

    Tag, TagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    TemplateLayoutConfiguration, TemplateLayoutConfigurationArgs

    Specifies the default layout to use when displaying cases created from this template. The layout determines which fields are visible and their arrangement in the agent interface.
    DefaultLayout string
    The unique identifier of a layout.
    DefaultLayout string
    The unique identifier of a layout.
    defaultLayout String
    The unique identifier of a layout.
    defaultLayout string
    The unique identifier of a layout.
    default_layout str
    The unique identifier of a layout.
    defaultLayout String
    The unique identifier of a layout.

    TemplateRequiredField, TemplateRequiredFieldArgs

    Wrapper object containing a field identifier
    FieldId string
    The unique identifier of a field.
    FieldId string
    The unique identifier of a field.
    fieldId String
    The unique identifier of a field.
    fieldId string
    The unique identifier of a field.
    field_id str
    The unique identifier of a field.
    fieldId String
    The unique identifier of a field.

    TemplateRule, TemplateRuleArgs

    Links a case rule to a specific field within this template. When specified, the rule's conditions will be evaluated for the associated field, controlling behavior like required status, visibility, or available options.
    CaseRuleId string
    The unique identifier of a case rule.
    FieldId string
    The ID of the field that this rule applies to.
    CaseRuleId string
    The unique identifier of a case rule.
    FieldId string
    The ID of the field that this rule applies to.
    caseRuleId String
    The unique identifier of a case rule.
    fieldId String
    The ID of the field that this rule applies to.
    caseRuleId string
    The unique identifier of a case rule.
    fieldId string
    The ID of the field that this rule applies to.
    case_rule_id str
    The unique identifier of a case rule.
    field_id str
    The ID of the field that this rule applies to.
    caseRuleId String
    The unique identifier of a case rule.
    fieldId String
    The ID of the field that this rule applies to.

    TemplateStatus, TemplateStatusArgs

    Active
    Active
    Inactive
    Inactive
    TemplateStatusActive
    Active
    TemplateStatusInactive
    Inactive
    Active
    Active
    Inactive
    Inactive
    Active
    Active
    Inactive
    Inactive
    ACTIVE
    Active
    INACTIVE
    Inactive
    "Active"
    Active
    "Inactive"
    Inactive

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.44.0 published on Friday, Dec 19, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native
      Meet Neo: Your AI Platform Teammate