@pulumi/aws-native/cases/field.d.ts

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)

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 field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.
 */
export declare class Field extends pulumi.CustomResource {
    /**
     * Get an existing Field 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): Field;
    /**
     * Returns true if the given object is an instance of Field.  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 Field;
    /**
     * The time at which the field was created.
     */
    readonly createdTime: pulumi.Output<string>;
    /**
     * A description explaining the purpose and usage of this field in cases. Helps agents and administrators understand what information should be captured in this field.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * The unique identifier of the Cases domain.
     */
    readonly domainId: pulumi.Output<string | undefined>;
    /**
     * The Amazon Resource Name (ARN) of the field.
     */
    readonly fieldArn: pulumi.Output<string>;
    /**
     * The unique identifier of a field.
     */
    readonly fieldId: pulumi.Output<string>;
    /**
     * The time at which the field was created or last modified.
     */
    readonly lastModifiedTime: pulumi.Output<string>;
    /**
     * The display name of the field as it appears to agents in the case interface. Should be descriptive and user-friendly (e.g., 'Customer Priority Level', 'Issue Category').
     */
    readonly name: pulumi.Output<string>;
    /**
     * Indicates whether this is a System field (predefined by AWS) or a Custom field (created by your organization). System fields cannot be modified or deleted.
     */
    readonly namespace: pulumi.Output<enums.cases.FieldNamespace>;
    /**
     * An array of key-value pairs to apply to this resource.
     */
    readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
    /**
     * Type of the field.
     */
    readonly type: pulumi.Output<enums.cases.FieldType>;
    /**
     * Create a Field 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: FieldArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * The set of arguments for constructing a Field resource.
 */
export interface FieldArgs {
    /**
     * A description explaining the purpose and usage of this field in cases. Helps agents and administrators understand what information should be captured in this field.
     */
    description?: pulumi.Input<string>;
    /**
     * The unique identifier of the Cases domain.
     */
    domainId?: pulumi.Input<string>;
    /**
     * The display name of the field as it appears to agents in the case interface. Should be descriptive and user-friendly (e.g., 'Customer Priority Level', 'Issue Category').
     */
    name?: pulumi.Input<string>;
    /**
     * An array of key-value pairs to apply to this resource.
     */
    tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
    /**
     * Type of the field.
     */
    type: pulumi.Input<enums.cases.FieldType>;
}