@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
117 lines (116 loc) • 4.83 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* 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.
*/
export declare class Template extends pulumi.CustomResource {
/**
* Get an existing Template resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Template;
/**
* Returns true if the given object is an instance of Template. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Template;
/**
* The time at which the template was created.
*/
readonly createdTime: pulumi.Output<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.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The unique identifier of the Cases domain.
*/
readonly domainId: pulumi.Output<string | undefined>;
/**
* The time at which the template was created or last modified.
*/
readonly lastModifiedTime: pulumi.Output<string>;
/**
* Object to store configuration of layouts associated to the template.
*/
readonly layoutConfiguration: pulumi.Output<outputs.cases.TemplateLayoutConfiguration | undefined>;
/**
* A name for the template. It must be unique per domain.
*/
readonly name: pulumi.Output<string>;
/**
* A list of fields that must contain a value for a case to be successfully created with this template.
*/
readonly requiredFields: pulumi.Output<outputs.cases.TemplateRequiredField[] | undefined>;
/**
* A list of case rules (also known as case field conditions) on a template.
*/
readonly rules: pulumi.Output<outputs.cases.TemplateRule[] | undefined>;
/**
* The status of the template.
*/
readonly status: pulumi.Output<enums.cases.TemplateStatus | undefined>;
/**
* The tags that you attach to this template.
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* The Amazon Resource Name (ARN) of the template.
*/
readonly templateArn: pulumi.Output<string>;
/**
* The unique identifier of a template.
*/
readonly templateId: pulumi.Output<string>;
/**
* Create a Template resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: TemplateArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Template resource.
*/
export interface TemplateArgs {
/**
* 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.
*/
description?: pulumi.Input<string>;
/**
* The unique identifier of the Cases domain.
*/
domainId?: pulumi.Input<string>;
/**
* Object to store configuration of layouts associated to the template.
*/
layoutConfiguration?: pulumi.Input<inputs.cases.TemplateLayoutConfigurationArgs>;
/**
* A name for the template. It must be unique per domain.
*/
name?: pulumi.Input<string>;
/**
* A list of fields that must contain a value for a case to be successfully created with this template.
*/
requiredFields?: pulumi.Input<pulumi.Input<inputs.cases.TemplateRequiredFieldArgs>[]>;
/**
* A list of case rules (also known as case field conditions) on a template.
*/
rules?: pulumi.Input<pulumi.Input<inputs.cases.TemplateRuleArgs>[]>;
/**
* The status of the template.
*/
status?: pulumi.Input<enums.cases.TemplateStatus>;
/**
* The tags that you attach to this template.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
}