@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
88 lines (87 loc) • 3.96 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource Type definition for AWS::SageMaker::UserProfile
*/
export declare class UserProfile extends pulumi.CustomResource {
/**
* Get an existing UserProfile resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): UserProfile;
/**
* Returns true if the given object is an instance of UserProfile. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is UserProfile;
/**
* The ID of the associated Domain.
*/
readonly domainId: pulumi.Output<string>;
/**
* A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified.
*/
readonly singleSignOnUserIdentifier: pulumi.Output<string | undefined>;
/**
* The username of the associated AWS Single Sign-On User for this UserProfile. If the Domain's AuthMode is SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified.
*/
readonly singleSignOnUserValue: pulumi.Output<string | undefined>;
/**
* A list of tags to apply to the user profile.
*/
readonly tags: pulumi.Output<outputs.CreateOnlyTag[] | undefined>;
/**
* The user profile Amazon Resource Name (ARN).
*/
readonly userProfileArn: pulumi.Output<string>;
/**
* A name for the UserProfile.
*/
readonly userProfileName: pulumi.Output<string>;
/**
* A collection of settings.
*/
readonly userSettings: pulumi.Output<outputs.sagemaker.UserProfileUserSettings | undefined>;
/**
* Create a UserProfile resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: UserProfileArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a UserProfile resource.
*/
export interface UserProfileArgs {
/**
* The ID of the associated Domain.
*/
domainId: pulumi.Input<string>;
/**
* A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified.
*/
singleSignOnUserIdentifier?: pulumi.Input<string>;
/**
* The username of the associated AWS Single Sign-On User for this UserProfile. If the Domain's AuthMode is SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified.
*/
singleSignOnUserValue?: pulumi.Input<string>;
/**
* A list of tags to apply to the user profile.
*/
tags?: pulumi.Input<pulumi.Input<inputs.CreateOnlyTagArgs>[]>;
/**
* A name for the UserProfile.
*/
userProfileName?: pulumi.Input<string>;
/**
* A collection of settings.
*/
userSettings?: pulumi.Input<inputs.sagemaker.UserProfileUserSettingsArgs>;
}