AWS::DataZone::UserProfile

The user type of the user for which the user profile is created.

Syntax

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

JSON

{
  "Type" : "AWS::DataZone::UserProfile",
  "Properties" : {
      "DomainIdentifier" : String,
      "Status" : String,
      "UserIdentifier" : String,
      "UserType" : String
    }
}

YAML

Type: AWS::DataZone::UserProfile
Properties:
  DomainIdentifier: String
  Status: String
  UserIdentifier: String
  UserType: String

Properties

DomainIdentifier

The identifier of a Amazon DataZone domain in which a user profile exists.

Required: Yes

Type: String

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

Update requires: Replacement

Status

The status of the user profile.

Required: No

Type: String

Allowed values: ASSIGNED | NOT_ASSIGNED | ACTIVATED | DEACTIVATED

Update requires: No interruption

UserIdentifier

The identifier of the user for which the user profile is created.

Required: Yes

Type: String

Pattern: (^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws:iam::\d{12}:.+$)

Update requires: Replacement

UserType

The user type of the user for which the user profile is created.

Required: No

Type: String

Allowed values: IAM_USER | IAM_ROLE | SSO_USER

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns a string containing pipe-separated DomainId and UserProfileId that uniquely identify the user profile. For example: { "Ref": "MyUserProfile" } for the resource with the logical ID MyUserProfile, Ref returns DomainId|UserProfileId.

For more information about using the Ref function, see Ref.

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.

DomainId

The identifier of a Amazon DataZone domain in which a user profile exists.

Id

The ID of the user profile.

Type

The type of the user profile.