Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. datazone
  5. UserProfile
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.datazone.UserProfile

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Resource for managing an AWS DataZone User Profile.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.datazone.UserProfile("example", {
    userIdentifier: exampleAwsIamUser.arn,
    domainIdentifier: exampleAwsDatazoneDomain.id,
    userType: "IAM_USER",
});

    import pulumi
import pulumi_aws as aws

example = aws.datazone.UserProfile("example",
    user_identifier=example_aws_iam_user["arn"],
    domain_identifier=example_aws_datazone_domain["id"],
    user_type="IAM_USER")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/datazone"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datazone.NewUserProfile(ctx, "example", &datazone.UserProfileArgs{
			UserIdentifier:   pulumi.Any(exampleAwsIamUser.Arn),
			DomainIdentifier: pulumi.Any(exampleAwsDatazoneDomain.Id),
			UserType:         pulumi.String("IAM_USER"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.DataZone.UserProfile("example", new()
    {
        UserIdentifier = exampleAwsIamUser.Arn,
        DomainIdentifier = exampleAwsDatazoneDomain.Id,
        UserType = "IAM_USER",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.datazone.UserProfile;
import com.pulumi.aws.datazone.UserProfileArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new UserProfile("example", UserProfileArgs.builder()
            .userIdentifier(exampleAwsIamUser.arn())
            .domainIdentifier(exampleAwsDatazoneDomain.id())
            .userType("IAM_USER")
            .build());

    }
}

    resources:
  example:
    type: aws:datazone:UserProfile
    properties:
      userIdentifier: ${exampleAwsIamUser.arn}
      domainIdentifier: ${exampleAwsDatazoneDomain.id}
      userType: IAM_USER

    Create UserProfile Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new UserProfile(name: string, args: UserProfileArgs, opts?: CustomResourceOptions);
    @overload
def UserProfile(resource_name: str,
                args: UserProfileArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def UserProfile(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                domain_identifier: Optional[str] = None,
                user_identifier: Optional[str] = None,
                status: Optional[str] = None,
                timeouts: Optional[UserProfileTimeoutsArgs] = None,
                user_type: Optional[str] = None)
    func NewUserProfile(ctx *Context, name string, args UserProfileArgs, opts ...ResourceOption) (*UserProfile, error)
    public UserProfile(string name, UserProfileArgs args, CustomResourceOptions? opts = null)
    public UserProfile(String name, UserProfileArgs args)
public UserProfile(String name, UserProfileArgs args, CustomResourceOptions options)

    type: aws:datazone:UserProfile
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 UserProfileArgs
    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 UserProfileArgs
    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 UserProfileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserProfileArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var userProfileResource = new Aws.DataZone.UserProfile("userProfileResource", new()
{
    DomainIdentifier = "string",
    UserIdentifier = "string",
    Status = "string",
    Timeouts = new Aws.DataZone.Inputs.UserProfileTimeoutsArgs
    {
        Create = "string",
        Update = "string",
    },
    UserType = "string",
});

    example, err := datazone.NewUserProfile(ctx, "userProfileResource", &datazone.UserProfileArgs{
	DomainIdentifier: pulumi.String("string"),
	UserIdentifier:   pulumi.String("string"),
	Status:           pulumi.String("string"),
	Timeouts: &datazone.UserProfileTimeoutsArgs{
		Create: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	UserType: pulumi.String("string"),
})

    var userProfileResource = new UserProfile("userProfileResource", UserProfileArgs.builder()
    .domainIdentifier("string")
    .userIdentifier("string")
    .status("string")
    .timeouts(UserProfileTimeoutsArgs.builder()
        .create("string")
        .update("string")
        .build())
    .userType("string")
    .build());

    user_profile_resource = aws.datazone.UserProfile("userProfileResource",
    domain_identifier="string",
    user_identifier="string",
    status="string",
    timeouts={
        "create": "string",
        "update": "string",
    },
    user_type="string")

    const userProfileResource = new aws.datazone.UserProfile("userProfileResource", {
    domainIdentifier: "string",
    userIdentifier: "string",
    status: "string",
    timeouts: {
        create: "string",
        update: "string",
    },
    userType: "string",
});

    type: aws:datazone:UserProfile
properties:
    domainIdentifier: string
    status: string
    timeouts:
        create: string
        update: string
    userIdentifier: string
    userType: string

    UserProfile 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 UserProfile resource accepts the following input properties:

    DomainIdentifier string
    The domain identifier.
    UserIdentifier string

    The user identifier.

    The following arguments are optional:

    Status string
    The user profile status.
    Timeouts UserProfileTimeouts
    UserType string
    The user type.
    DomainIdentifier string
    The domain identifier.
    UserIdentifier string

    The user identifier.

    The following arguments are optional:

    Status string
    The user profile status.
    Timeouts UserProfileTimeoutsArgs
    UserType string
    The user type.
    domainIdentifier String
    The domain identifier.
    userIdentifier String

    The user identifier.

    The following arguments are optional:

    status String
    The user profile status.
    timeouts UserProfileTimeouts
    userType String
    The user type.
    domainIdentifier string
    The domain identifier.
    userIdentifier string

    The user identifier.

    The following arguments are optional:

    status string
    The user profile status.
    timeouts UserProfileTimeouts
    userType string
    The user type.
    domain_identifier str
    The domain identifier.
    user_identifier str

    The user identifier.

    The following arguments are optional:

    status str
    The user profile status.
    timeouts UserProfileTimeoutsArgs
    user_type str
    The user type.
    domainIdentifier String
    The domain identifier.
    userIdentifier String

    The user identifier.

    The following arguments are optional:

    status String
    The user profile status.
    timeouts Property Map
    userType String
    The user type.

    Outputs

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

    Details List<UserProfileDetail>
    Details about the user profile.
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    The user profile type.
    Details []UserProfileDetail
    Details about the user profile.
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    The user profile type.
    details List<UserProfileDetail>
    Details about the user profile.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    The user profile type.
    details UserProfileDetail[]
    Details about the user profile.
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    The user profile type.
    details Sequence[UserProfileDetail]
    Details about the user profile.
    id str
    The provider-assigned unique ID for this managed resource.
    type str
    The user profile type.
    details List<Property Map>
    Details about the user profile.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    The user profile type.

    Look up Existing UserProfile Resource

    Get an existing UserProfile resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: UserProfileState, opts?: CustomResourceOptions): UserProfile
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        details: Optional[Sequence[UserProfileDetailArgs]] = None,
        domain_identifier: Optional[str] = None,
        status: Optional[str] = None,
        timeouts: Optional[UserProfileTimeoutsArgs] = None,
        type: Optional[str] = None,
        user_identifier: Optional[str] = None,
        user_type: Optional[str] = None) -> UserProfile
    func GetUserProfile(ctx *Context, name string, id IDInput, state *UserProfileState, opts ...ResourceOption) (*UserProfile, error)
    public static UserProfile Get(string name, Input<string> id, UserProfileState? state, CustomResourceOptions? opts = null)
    public static UserProfile get(String name, Output<String> id, UserProfileState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Details List<UserProfileDetail>
    Details about the user profile.
    DomainIdentifier string
    The domain identifier.
    Status string
    The user profile status.
    Timeouts UserProfileTimeouts
    Type string
    The user profile type.
    UserIdentifier string

    The user identifier.

    The following arguments are optional:

    UserType string
    The user type.
    Details []UserProfileDetailArgs
    Details about the user profile.
    DomainIdentifier string
    The domain identifier.
    Status string
    The user profile status.
    Timeouts UserProfileTimeoutsArgs
    Type string
    The user profile type.
    UserIdentifier string

    The user identifier.

    The following arguments are optional:

    UserType string
    The user type.
    details List<UserProfileDetail>
    Details about the user profile.
    domainIdentifier String
    The domain identifier.
    status String
    The user profile status.
    timeouts UserProfileTimeouts
    type String
    The user profile type.
    userIdentifier String

    The user identifier.

    The following arguments are optional:

    userType String
    The user type.
    details UserProfileDetail[]
    Details about the user profile.
    domainIdentifier string
    The domain identifier.
    status string
    The user profile status.
    timeouts UserProfileTimeouts
    type string
    The user profile type.
    userIdentifier string

    The user identifier.

    The following arguments are optional:

    userType string
    The user type.
    details Sequence[UserProfileDetailArgs]
    Details about the user profile.
    domain_identifier str
    The domain identifier.
    status str
    The user profile status.
    timeouts UserProfileTimeoutsArgs
    type str
    The user profile type.
    user_identifier str

    The user identifier.

    The following arguments are optional:

    user_type str
    The user type.
    details List<Property Map>
    Details about the user profile.
    domainIdentifier String
    The domain identifier.
    status String
    The user profile status.
    timeouts Property Map
    type String
    The user profile type.
    userIdentifier String

    The user identifier.

    The following arguments are optional:

    userType String
    The user type.

    Supporting Types

    UserProfileDetail, UserProfileDetailArgs

    UserProfileDetailIam, UserProfileDetailIamArgs

    Arn string
    Arn string
    arn String
    arn string
    arn str
    arn String

    UserProfileDetailSso, UserProfileDetailSsoArgs

    FirstName string
    LastName string
    UserName string
    FirstName string
    LastName string
    UserName string
    firstName String
    lastName String
    userName String
    firstName string
    lastName string
    userName string
    firstName String
    lastName String
    userName String

    UserProfileTimeouts, UserProfileTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Import

    Using pulumi import, import DataZone User Profile using the user_identifier,domain_identifier,type. For example:

    $ pulumi import aws:datazone/userProfile:UserProfile example arn:aws:iam::123456789012:user/example,dzd_54nakfrg9k6suo,IAM

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws