AWS::DataZone::FormType

The details of the metadata form type.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::DataZone::FormType",
  "Properties" : {
      "Description" : String,
      "DomainIdentifier" : String,
      "Model" : Model,
      "Name" : String,
      "OwningProjectIdentifier" : String,
      "Status" : String
    }
}

YAML

Type: AWS::DataZone::FormType
Properties:
  Description: String
  DomainIdentifier: String
  Model: 
    Model
  Name: String
  OwningProjectIdentifier: String
  Status: String

Properties

Description

The description of the metadata form type.

Required: No

Type: String

Minimum: 0

Maximum: 2048

Update requires: Some interruptions

DomainIdentifier

The identifier of the Amazon DataZone domain in which the form type exists.

Required: Yes

Type: String

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

Update requires: Replacement

Model

The model of the form type.

Required: Yes

Type: Model

Update requires: Some interruptions

Name

The name of the form type.

Required: Yes

Type: String

Pattern: ^(?![0-9_])\w+$|^_\w*[a-zA-Z0-9]\w*$

Minimum: 1

Maximum: 128

Update requires: Replacement

OwningProjectIdentifier

The identifier of the project that owns the form type.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

Update requires: Some interruptions

Status

The status of the form type.

Required: No

Type: String

Allowed values: ENABLED | DISABLED

Update requires: Some interruptions

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns a string containing pipe-separated DomainIdentifier and FormTypeIdentifier, which uniquely identifies a form type. For example: {"Ref": "MyFormType" } for the resource with the logical ID MyFormType, Ref returns DomainIdentifier|FormTypeIdentifier.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreatedAt

The timestamp of when the metadata form type was created.

CreatedBy

The Amazon DataZone user who created teh metadata form type.

DomainId

The identifier of the Amazon DataZone domain in which the form type exists.

FormTypeIdentifier

The ID of the metadata form type.

OwningProjectId

The identifier of the project that owns the form type.

Revision

The revision of the form type.