@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)
92 lines (91 loc) • 3.94 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* A case rule. In the Amazon Connect admin website, case rules are known as case field conditions. Case rules are used to define the situations under which fields should have certain effects (such as required).
*/
export declare class CaseRule extends pulumi.CustomResource {
/**
* Get an existing CaseRule 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): CaseRule;
/**
* Returns true if the given object is an instance of CaseRule. 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 CaseRule;
/**
* The Amazon Resource Name (ARN) of a case rule.
*/
readonly caseRuleArn: pulumi.Output<string>;
/**
* The unique identifier of a case rule.
*/
readonly caseRuleId: pulumi.Output<string>;
/**
* The time at which the case rule was created.
*/
readonly createdTime: pulumi.Output<string>;
/**
* A description explaining the purpose and behavior of this case rule. Helps administrators understand when and why this rule applies to case fields.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The unique identifier of the Cases domain.
*/
readonly domainId: pulumi.Output<string | undefined>;
/**
* The time at which the case rule was created or last modified.
*/
readonly lastModifiedTime: pulumi.Output<string>;
/**
* A descriptive name for the case rule. Must be unique within the domain and should clearly indicate the rule's purpose (e.g., 'Priority Field Required for Urgent Cases').
*/
readonly name: pulumi.Output<string>;
/**
* Represents what rule type should take place, under what conditions.
*/
readonly rule: pulumi.Output<outputs.cases.CaseRuleDetails0Properties | outputs.cases.CaseRuleDetails1Properties>;
/**
* The tags that you attach to this case rule.
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* Create a CaseRule 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: CaseRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a CaseRule resource.
*/
export interface CaseRuleArgs {
/**
* A description explaining the purpose and behavior of this case rule. Helps administrators understand when and why this rule applies to case fields.
*/
description?: pulumi.Input<string>;
/**
* The unique identifier of the Cases domain.
*/
domainId?: pulumi.Input<string>;
/**
* A descriptive name for the case rule. Must be unique within the domain and should clearly indicate the rule's purpose (e.g., 'Priority Field Required for Urgent Cases').
*/
name?: pulumi.Input<string>;
/**
* Represents what rule type should take place, under what conditions.
*/
rule: pulumi.Input<inputs.cases.CaseRuleDetails0PropertiesArgs | inputs.cases.CaseRuleDetails1PropertiesArgs>;
/**
* The tags that you attach to this case rule.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
}