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

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.Field

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 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)
    public Field(String name, FieldArgs args)
public Field(String name, FieldArgs args, CustomResourceOptions options)

    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.AwsNative.Cases.FieldType
    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.
    DomainId 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').
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Type FieldType
    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.
    DomainId 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').
    Tags TagArgs
    type FieldType
    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.
    domainId 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').
    tags List<Tag>
    type FieldType
    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.
    domainId 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').
    tags Tag[]
    type FieldType
    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').
    tags Sequence[TagArgs]
    type "Text" | "Number" | "Boolean" | "DateTime" | "SingleSelect" | "Url" | "User"
    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.
    domainId 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').
    tags List<Property Map>

    Outputs

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

    CreatedTime string
    The time at which the field was created.
    FieldArn string
    The Amazon Resource Name (ARN) of the field.
    FieldId string
    The unique identifier of a field.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedTime string
    The time at which the field was created or last modified.
    Namespace Pulumi.AwsNative.Cases.FieldNamespace
    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.
    CreatedTime string
    The time at which the field was created.
    FieldArn string
    The Amazon Resource Name (ARN) of the field.
    FieldId string
    The unique identifier of a field.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedTime string
    The time at which the field was created or last modified.
    Namespace FieldNamespace
    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.
    createdTime String
    The time at which the field was created.
    fieldArn String
    The Amazon Resource Name (ARN) of the field.
    fieldId String
    The unique identifier of a field.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime String
    The time at which the field was created or last modified.
    namespace FieldNamespace
    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.
    createdTime string
    The time at which the field was created.
    fieldArn string
    The Amazon Resource Name (ARN) of the field.
    fieldId string
    The unique identifier of a field.
    id string
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime string
    The time at which the field was created or last modified.
    namespace FieldNamespace
    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_time str
    The time at which the field was created or last modified.
    namespace FieldNamespace
    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.
    createdTime String
    The time at which the field was created.
    fieldArn String
    The Amazon Resource Name (ARN) of the field.
    fieldId String
    The unique identifier of a field.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime String
    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
    FieldNamespaceSystem
    System
    FieldNamespaceCustom
    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
    DateTime
    DateTime
    SingleSelect
    SingleSelect
    Url
    Url
    User
    User
    FieldTypeText
    Text
    FieldTypeNumber
    Number
    FieldTypeBoolean
    Boolean
    FieldTypeDateTime
    DateTime
    FieldTypeSingleSelect
    SingleSelect
    FieldTypeUrl
    Url
    FieldTypeUser
    User
    Text
    Text
    Number
    Number
    Boolean
    Boolean
    DateTime
    DateTime
    SingleSelect
    SingleSelect
    Url
    Url
    User
    User
    Text
    Text
    Number
    Number
    Boolean
    Boolean
    DateTime
    DateTime
    SingleSelect
    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
    "DateTime"
    DateTime
    "SingleSelect"
    SingleSelect
    "Url"
    Url
    "User"
    User

    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

    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