quicksight

Documentation

Index

• type Group
  • func GetGroup(ctx *pulumi.Context, name string, id pulumi.IDInput, state *GroupState, ...) (*Group, error)
  • func NewGroup(ctx *pulumi.Context, name string, args *GroupArgs, ...) (*Group, error)
• type GroupArgs
  • func (GroupArgs) ElementType() reflect.Type
• type GroupState
  • func (GroupState) ElementType() reflect.Type
• type User
  • func GetUser(ctx *pulumi.Context, name string, id pulumi.IDInput, state *UserState, ...) (*User, error)
  • func NewUser(ctx *pulumi.Context, name string, args *UserArgs, ...) (*User, error)
• type UserArgs
  • func (UserArgs) ElementType() reflect.Type
• type UserState
  • func (UserState) ElementType() reflect.Type

Types

type Group

type Group struct {
	pulumi.CustomResourceState

	// Amazon Resource Name (ARN) of group
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
	AwsAccountId pulumi.StringOutput `pulumi:"awsAccountId"`
	// A description for the group.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// A name for the group.
	GroupName pulumi.StringOutput `pulumi:"groupName"`
	// The namespace. Currently, you should set this to `default`.
	Namespace pulumi.StringPtrOutput `pulumi:"namespace"`
}

Resource for managing QuickSight Group

func GetGroup

func GetGroup(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *GroupState, opts ...pulumi.ResourceOption) (*Group, error)

GetGroup gets an existing Group resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewGroup

func NewGroup(ctx *pulumi.Context,
	name string, args *GroupArgs, opts ...pulumi.ResourceOption) (*Group, error)

NewGroup registers a new resource with the given unique name, arguments, and options.

type GroupArgs

type GroupArgs struct {
	// The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
	AwsAccountId pulumi.StringPtrInput
	// A description for the group.
	Description pulumi.StringPtrInput
	// A name for the group.
	GroupName pulumi.StringInput
	// The namespace. Currently, you should set this to `default`.
	Namespace pulumi.StringPtrInput
}

The set of arguments for constructing a Group resource.

func (GroupArgs) ElementType

func (GroupArgs) ElementType() reflect.Type

type GroupState

type GroupState struct {
	// Amazon Resource Name (ARN) of group
	Arn pulumi.StringPtrInput
	// The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
	AwsAccountId pulumi.StringPtrInput
	// A description for the group.
	Description pulumi.StringPtrInput
	// A name for the group.
	GroupName pulumi.StringPtrInput
	// The namespace. Currently, you should set this to `default`.
	Namespace pulumi.StringPtrInput
}

func (GroupState) ElementType

func (GroupState) ElementType() reflect.Type

type User

type User struct {
	pulumi.CustomResourceState

	// Amazon Resource Name (ARN) of the user
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
	AwsAccountId pulumi.StringOutput `pulumi:"awsAccountId"`
	// The email address of the user that you want to register.
	Email pulumi.StringOutput `pulumi:"email"`
	// The ARN of the IAM user or role that you are registering with Amazon QuickSight.
	IamArn pulumi.StringPtrOutput `pulumi:"iamArn"`
	// Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts either  `IAM` or `QUICKSIGHT`.
	IdentityType pulumi.StringOutput `pulumi:"identityType"`
	// The namespace. Currently, you should set this to `default`.
	Namespace pulumi.StringPtrOutput `pulumi:"namespace"`
	// The name of the IAM session to use when assuming roles that can embed QuickSight dashboards.
	SessionName pulumi.StringPtrOutput `pulumi:"sessionName"`
	// The Amazon QuickSight user name that you want to create for the user you are registering.
	UserName pulumi.StringPtrOutput `pulumi:"userName"`
	// The Amazon QuickSight role of the user. The user role can be one of the following: `READER`, `AUTHOR`, or `ADMIN`
	UserRole pulumi.StringOutput `pulumi:"userRole"`
}

Resource for managing QuickSight User

func GetUser

func GetUser(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *UserState, opts ...pulumi.ResourceOption) (*User, error)

GetUser gets an existing User resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewUser

func NewUser(ctx *pulumi.Context,
	name string, args *UserArgs, opts ...pulumi.ResourceOption) (*User, error)

NewUser registers a new resource with the given unique name, arguments, and options.

type UserArgs

type UserArgs struct {
	// The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
	AwsAccountId pulumi.StringPtrInput
	// The email address of the user that you want to register.
	Email pulumi.StringInput
	// The ARN of the IAM user or role that you are registering with Amazon QuickSight.
	IamArn pulumi.StringPtrInput
	// Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts either  `IAM` or `QUICKSIGHT`.
	IdentityType pulumi.StringInput
	// The namespace. Currently, you should set this to `default`.
	Namespace pulumi.StringPtrInput
	// The name of the IAM session to use when assuming roles that can embed QuickSight dashboards.
	SessionName pulumi.StringPtrInput
	// The Amazon QuickSight user name that you want to create for the user you are registering.
	UserName pulumi.StringPtrInput
	// The Amazon QuickSight role of the user. The user role can be one of the following: `READER`, `AUTHOR`, or `ADMIN`
	UserRole pulumi.StringInput
}

The set of arguments for constructing a User resource.

func (UserArgs) ElementType

func (UserArgs) ElementType() reflect.Type

type UserState

type UserState struct {
	// Amazon Resource Name (ARN) of the user
	Arn pulumi.StringPtrInput
	// The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
	AwsAccountId pulumi.StringPtrInput
	// The email address of the user that you want to register.
	Email pulumi.StringPtrInput
	// The ARN of the IAM user or role that you are registering with Amazon QuickSight.
	IamArn pulumi.StringPtrInput
	// Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts either  `IAM` or `QUICKSIGHT`.
	IdentityType pulumi.StringPtrInput
	// The namespace. Currently, you should set this to `default`.
	Namespace pulumi.StringPtrInput
	// The name of the IAM session to use when assuming roles that can embed QuickSight dashboards.
	SessionName pulumi.StringPtrInput
	// The Amazon QuickSight user name that you want to create for the user you are registering.
	UserName pulumi.StringPtrInput
	// The Amazon QuickSight role of the user. The user role can be one of the following: `READER`, `AUTHOR`, or `ADMIN`
	UserRole pulumi.StringPtrInput
}

func (UserState) ElementType

func (UserState) ElementType() reflect.Type