We recommend new projects start with resources from the AWS provider.
We recommend new projects start with resources from the AWS provider.
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.
Create Field Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Field(name: string, args: FieldArgs, opts?: CustomResourceOptions);@overload
def Field(resource_name: str,
args: FieldArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Field(resource_name: str,
opts: Optional[ResourceOptions] = None,
type: Optional[FieldType] = None,
description: Optional[str] = None,
domain_id: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewField(ctx *Context, name string, args FieldArgs, opts ...ResourceOption) (*Field, error)public Field(string name, FieldArgs args, CustomResourceOptions? opts = null)type: aws-native:cases:Field
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 FieldArgs
- 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 FieldArgs
- 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 FieldArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FieldArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FieldArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Field 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 Field resource accepts the following input properties:
- Type
Pulumi.
Aws Native. Cases. Field Type - Type of the field.
- Description 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.
- Domain
Id string - The unique identifier of the Cases domain.
- Name 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').
-
List<Pulumi.
Aws Native. Inputs. Tag> - An array of key-value pairs to apply to this resource.
- Type
Field
Type - Type of the field.
- Description 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.
- Domain
Id string - The unique identifier of the Cases domain.
- Name 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').
-
Tag
Args - An array of key-value pairs to apply to this resource.
- type
Field
Type - Type of the field.
- description 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.
- domain
Id String - The unique identifier of the Cases domain.
- name 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').
- List<Tag>
- An array of key-value pairs to apply to this resource.
- type
Field
Type - Type of the field.
- description 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.
- domain
Id string - The unique identifier of the Cases domain.
- name 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').
- Tag[]
- An array of key-value pairs to apply to this resource.
- type
Field
Type - Type of the field.
- description str
- 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.
- domain_
id str - The unique identifier of the Cases domain.
- name str
- 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').
-
Sequence[Tag
Args] - An array of key-value pairs to apply to this resource.
- type
"Text" | "Number" | "Boolean" | "Date
Time" | "Single Select" | "Url" | "User" - Type of the field.
- description 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.
- domain
Id String - The unique identifier of the Cases domain.
- name 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').
- List<Property Map>
- An array of key-value pairs to apply to this resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the Field resource produces the following output properties:
- Created
Time string - The time at which the field was created.
- Field
Arn string - The Amazon Resource Name (ARN) of the field.
- Field
Id string - The unique identifier of a field.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringTime - The time at which the field was created or last modified.
- Namespace
Pulumi.
Aws Native. Cases. Field Namespace - 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.
- Created
Time string - The time at which the field was created.
- Field
Arn string - The Amazon Resource Name (ARN) of the field.
- Field
Id string - The unique identifier of a field.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringTime - The time at which the field was created or last modified.
- Namespace
Field
Namespace - 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.
- created
Time String - The time at which the field was created.
- field
Arn String - The Amazon Resource Name (ARN) of the field.
- field
Id String - The unique identifier of a field.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringTime - The time at which the field was created or last modified.
- namespace
Field
Namespace - 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.
- created
Time string - The time at which the field was created.
- field
Arn string - The Amazon Resource Name (ARN) of the field.
- field
Id string - The unique identifier of a field.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Modified stringTime - The time at which the field was created or last modified.
- namespace
Field
Namespace - 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.
- created_
time str - The time at which the field was created.
- field_
arn str - The Amazon Resource Name (ARN) of the field.
- field_
id str - The unique identifier of a field.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
modified_ strtime - The time at which the field was created or last modified.
- namespace
Field
Namespace - 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.
- created
Time String - The time at which the field was created.
- field
Arn String - The Amazon Resource Name (ARN) of the field.
- field
Id String - The unique identifier of a field.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringTime - The time at which the field was created or last modified.
- namespace "System" | "Custom"
- 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.
Supporting Types
FieldNamespace, FieldNamespaceArgs
- System
System- Custom
Custom
- Field
Namespace System System- Field
Namespace Custom Custom
- System
System- Custom
Custom
- System
System- Custom
Custom
- SYSTEM
System- CUSTOM
Custom
- "System"
System- "Custom"
Custom
FieldType, FieldTypeArgs
- Text
Text- Number
Number- Boolean
Boolean- Date
Time DateTime- Single
Select SingleSelect- Url
Url- User
User
- Field
Type Text Text- Field
Type Number Number- Field
Type Boolean Boolean- Field
Type Date Time DateTime- Field
Type Single Select SingleSelect- Field
Type Url Url- Field
Type User User
- Text
Text- Number
Number- Boolean
Boolean- Date
Time DateTime- Single
Select SingleSelect- Url
Url- User
User
- Text
Text- Number
Number- Boolean
Boolean- Date
Time DateTime- Single
Select SingleSelect- Url
Url- User
User
- TEXT
Text- NUMBER
Number- BOOLEAN
Boolean- DATE_TIME
DateTime- SINGLE_SELECT
SingleSelect- URL
Url- USER
User
- "Text"
Text- "Number"
Number- "Boolean"
Boolean- "Date
Time" DateTime- "Single
Select" SingleSelect- "Url"
Url- "User"
User
Tag, TagArgs
A set of tags to apply to the resource.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
