Documentation ¶
Index ¶
- type Group
- type GroupArgs
- type GroupArray
- type GroupArrayInput
- type GroupArrayOutput
- type GroupInput
- type GroupMap
- type GroupMapInput
- type GroupMapOutput
- type GroupMembership
- func (*GroupMembership) ElementType() reflect.Type
- func (i *GroupMembership) ToGroupMembershipOutput() GroupMembershipOutput
- func (i *GroupMembership) ToGroupMembershipOutputWithContext(ctx context.Context) GroupMembershipOutput
- func (i *GroupMembership) ToGroupMembershipPtrOutput() GroupMembershipPtrOutput
- func (i *GroupMembership) ToGroupMembershipPtrOutputWithContext(ctx context.Context) GroupMembershipPtrOutput
- type GroupMembershipArgs
- type GroupMembershipArray
- type GroupMembershipArrayInput
- type GroupMembershipArrayOutput
- func (GroupMembershipArrayOutput) ElementType() reflect.Type
- func (o GroupMembershipArrayOutput) Index(i pulumi.IntInput) GroupMembershipOutput
- func (o GroupMembershipArrayOutput) ToGroupMembershipArrayOutput() GroupMembershipArrayOutput
- func (o GroupMembershipArrayOutput) ToGroupMembershipArrayOutputWithContext(ctx context.Context) GroupMembershipArrayOutput
- type GroupMembershipInput
- type GroupMembershipMap
- type GroupMembershipMapInput
- type GroupMembershipMapOutput
- func (GroupMembershipMapOutput) ElementType() reflect.Type
- func (o GroupMembershipMapOutput) MapIndex(k pulumi.StringInput) GroupMembershipOutput
- func (o GroupMembershipMapOutput) ToGroupMembershipMapOutput() GroupMembershipMapOutput
- func (o GroupMembershipMapOutput) ToGroupMembershipMapOutputWithContext(ctx context.Context) GroupMembershipMapOutput
- type GroupMembershipOutput
- func (GroupMembershipOutput) ElementType() reflect.Type
- func (o GroupMembershipOutput) ToGroupMembershipOutput() GroupMembershipOutput
- func (o GroupMembershipOutput) ToGroupMembershipOutputWithContext(ctx context.Context) GroupMembershipOutput
- func (o GroupMembershipOutput) ToGroupMembershipPtrOutput() GroupMembershipPtrOutput
- func (o GroupMembershipOutput) ToGroupMembershipPtrOutputWithContext(ctx context.Context) GroupMembershipPtrOutput
- type GroupMembershipPtrInput
- type GroupMembershipPtrOutput
- func (o GroupMembershipPtrOutput) Elem() GroupMembershipOutput
- func (GroupMembershipPtrOutput) ElementType() reflect.Type
- func (o GroupMembershipPtrOutput) ToGroupMembershipPtrOutput() GroupMembershipPtrOutput
- func (o GroupMembershipPtrOutput) ToGroupMembershipPtrOutputWithContext(ctx context.Context) GroupMembershipPtrOutput
- type GroupMembershipState
- type GroupOutput
- func (GroupOutput) ElementType() reflect.Type
- func (o GroupOutput) ToGroupOutput() GroupOutput
- func (o GroupOutput) ToGroupOutputWithContext(ctx context.Context) GroupOutput
- func (o GroupOutput) ToGroupPtrOutput() GroupPtrOutput
- func (o GroupOutput) ToGroupPtrOutputWithContext(ctx context.Context) GroupPtrOutput
- type GroupPtrInput
- type GroupPtrOutput
- type GroupState
- type User
- type UserArgs
- type UserArray
- type UserArrayInput
- type UserArrayOutput
- type UserInput
- type UserMap
- type UserMapInput
- type UserMapOutput
- type UserOutput
- func (UserOutput) ElementType() reflect.Type
- func (o UserOutput) ToUserOutput() UserOutput
- func (o UserOutput) ToUserOutputWithContext(ctx context.Context) UserOutput
- func (o UserOutput) ToUserPtrOutput() UserPtrOutput
- func (o UserOutput) ToUserPtrOutputWithContext(ctx context.Context) UserPtrOutput
- type UserPtrInput
- type UserPtrOutput
- type UserState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/quicksight" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := quicksight.NewGroup(ctx, "example", &quicksight.GroupArgs{ GroupName: pulumi.String("tf-example"), }) if err != nil { return err } return nil }) }
```
## Import
QuickSight Group can be imported using the aws account id, namespace and group name separated by `/`.
```sh
$ pulumi import aws:quicksight/group:Group example 123456789123/default/tf-example
```
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.
func (*Group) ElementType ¶
func (*Group) ToGroupOutput ¶
func (i *Group) ToGroupOutput() GroupOutput
func (*Group) ToGroupOutputWithContext ¶
func (i *Group) ToGroupOutputWithContext(ctx context.Context) GroupOutput
func (*Group) ToGroupPtrOutput ¶
func (i *Group) ToGroupPtrOutput() GroupPtrOutput
func (*Group) ToGroupPtrOutputWithContext ¶
func (i *Group) ToGroupPtrOutputWithContext(ctx context.Context) GroupPtrOutput
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 ¶
type GroupArray ¶
type GroupArray []GroupInput
func (GroupArray) ElementType ¶
func (GroupArray) ElementType() reflect.Type
func (GroupArray) ToGroupArrayOutput ¶
func (i GroupArray) ToGroupArrayOutput() GroupArrayOutput
func (GroupArray) ToGroupArrayOutputWithContext ¶
func (i GroupArray) ToGroupArrayOutputWithContext(ctx context.Context) GroupArrayOutput
type GroupArrayInput ¶
type GroupArrayInput interface { pulumi.Input ToGroupArrayOutput() GroupArrayOutput ToGroupArrayOutputWithContext(context.Context) GroupArrayOutput }
GroupArrayInput is an input type that accepts GroupArray and GroupArrayOutput values. You can construct a concrete instance of `GroupArrayInput` via:
GroupArray{ GroupArgs{...} }
type GroupArrayOutput ¶
type GroupArrayOutput struct{ *pulumi.OutputState }
func (GroupArrayOutput) ElementType ¶
func (GroupArrayOutput) ElementType() reflect.Type
func (GroupArrayOutput) Index ¶
func (o GroupArrayOutput) Index(i pulumi.IntInput) GroupOutput
func (GroupArrayOutput) ToGroupArrayOutput ¶
func (o GroupArrayOutput) ToGroupArrayOutput() GroupArrayOutput
func (GroupArrayOutput) ToGroupArrayOutputWithContext ¶
func (o GroupArrayOutput) ToGroupArrayOutputWithContext(ctx context.Context) GroupArrayOutput
type GroupInput ¶
type GroupInput interface { pulumi.Input ToGroupOutput() GroupOutput ToGroupOutputWithContext(ctx context.Context) GroupOutput }
type GroupMap ¶
type GroupMap map[string]GroupInput
func (GroupMap) ElementType ¶
func (GroupMap) ToGroupMapOutput ¶
func (i GroupMap) ToGroupMapOutput() GroupMapOutput
func (GroupMap) ToGroupMapOutputWithContext ¶
func (i GroupMap) ToGroupMapOutputWithContext(ctx context.Context) GroupMapOutput
type GroupMapInput ¶
type GroupMapInput interface { pulumi.Input ToGroupMapOutput() GroupMapOutput ToGroupMapOutputWithContext(context.Context) GroupMapOutput }
GroupMapInput is an input type that accepts GroupMap and GroupMapOutput values. You can construct a concrete instance of `GroupMapInput` via:
GroupMap{ "key": GroupArgs{...} }
type GroupMapOutput ¶
type GroupMapOutput struct{ *pulumi.OutputState }
func (GroupMapOutput) ElementType ¶
func (GroupMapOutput) ElementType() reflect.Type
func (GroupMapOutput) MapIndex ¶
func (o GroupMapOutput) MapIndex(k pulumi.StringInput) GroupOutput
func (GroupMapOutput) ToGroupMapOutput ¶
func (o GroupMapOutput) ToGroupMapOutput() GroupMapOutput
func (GroupMapOutput) ToGroupMapOutputWithContext ¶
func (o GroupMapOutput) ToGroupMapOutputWithContext(ctx context.Context) GroupMapOutput
type GroupMembership ¶ added in v4.20.0
type GroupMembership struct { pulumi.CustomResourceState 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"` // The name of the group in which the member will be added. GroupName pulumi.StringOutput `pulumi:"groupName"` // The name of the member to add to the group. MemberName pulumi.StringOutput `pulumi:"memberName"` // The namespace. Defaults to `default`. Currently only `default` is supported. Namespace pulumi.StringPtrOutput `pulumi:"namespace"` }
Resource for managing QuickSight Group Membership
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/quicksight" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := quicksight.NewGroupMembership(ctx, "example", &quicksight.GroupMembershipArgs{ GroupName: pulumi.String("all-access-users"), MemberName: pulumi.String("john_smith"), }) if err != nil { return err } return nil }) }
```
## Import
QuickSight Group membership can be imported using the AWS account ID, namespace, group name and member name separated by `/`.
```sh
$ pulumi import aws:quicksight/groupMembership:GroupMembership example 123456789123/default/all-access-users/john_smith
```
func GetGroupMembership ¶ added in v4.20.0
func GetGroupMembership(ctx *pulumi.Context, name string, id pulumi.IDInput, state *GroupMembershipState, opts ...pulumi.ResourceOption) (*GroupMembership, error)
GetGroupMembership gets an existing GroupMembership 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 NewGroupMembership ¶ added in v4.20.0
func NewGroupMembership(ctx *pulumi.Context, name string, args *GroupMembershipArgs, opts ...pulumi.ResourceOption) (*GroupMembership, error)
NewGroupMembership registers a new resource with the given unique name, arguments, and options.
func (*GroupMembership) ElementType ¶ added in v4.20.0
func (*GroupMembership) ElementType() reflect.Type
func (*GroupMembership) ToGroupMembershipOutput ¶ added in v4.20.0
func (i *GroupMembership) ToGroupMembershipOutput() GroupMembershipOutput
func (*GroupMembership) ToGroupMembershipOutputWithContext ¶ added in v4.20.0
func (i *GroupMembership) ToGroupMembershipOutputWithContext(ctx context.Context) GroupMembershipOutput
func (*GroupMembership) ToGroupMembershipPtrOutput ¶ added in v4.20.0
func (i *GroupMembership) ToGroupMembershipPtrOutput() GroupMembershipPtrOutput
func (*GroupMembership) ToGroupMembershipPtrOutputWithContext ¶ added in v4.20.0
func (i *GroupMembership) ToGroupMembershipPtrOutputWithContext(ctx context.Context) GroupMembershipPtrOutput
type GroupMembershipArgs ¶ added in v4.20.0
type GroupMembershipArgs 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 // The name of the group in which the member will be added. GroupName pulumi.StringInput // The name of the member to add to the group. MemberName pulumi.StringInput // The namespace. Defaults to `default`. Currently only `default` is supported. Namespace pulumi.StringPtrInput }
The set of arguments for constructing a GroupMembership resource.
func (GroupMembershipArgs) ElementType ¶ added in v4.20.0
func (GroupMembershipArgs) ElementType() reflect.Type
type GroupMembershipArray ¶ added in v4.20.0
type GroupMembershipArray []GroupMembershipInput
func (GroupMembershipArray) ElementType ¶ added in v4.20.0
func (GroupMembershipArray) ElementType() reflect.Type
func (GroupMembershipArray) ToGroupMembershipArrayOutput ¶ added in v4.20.0
func (i GroupMembershipArray) ToGroupMembershipArrayOutput() GroupMembershipArrayOutput
func (GroupMembershipArray) ToGroupMembershipArrayOutputWithContext ¶ added in v4.20.0
func (i GroupMembershipArray) ToGroupMembershipArrayOutputWithContext(ctx context.Context) GroupMembershipArrayOutput
type GroupMembershipArrayInput ¶ added in v4.20.0
type GroupMembershipArrayInput interface { pulumi.Input ToGroupMembershipArrayOutput() GroupMembershipArrayOutput ToGroupMembershipArrayOutputWithContext(context.Context) GroupMembershipArrayOutput }
GroupMembershipArrayInput is an input type that accepts GroupMembershipArray and GroupMembershipArrayOutput values. You can construct a concrete instance of `GroupMembershipArrayInput` via:
GroupMembershipArray{ GroupMembershipArgs{...} }
type GroupMembershipArrayOutput ¶ added in v4.20.0
type GroupMembershipArrayOutput struct{ *pulumi.OutputState }
func (GroupMembershipArrayOutput) ElementType ¶ added in v4.20.0
func (GroupMembershipArrayOutput) ElementType() reflect.Type
func (GroupMembershipArrayOutput) Index ¶ added in v4.20.0
func (o GroupMembershipArrayOutput) Index(i pulumi.IntInput) GroupMembershipOutput
func (GroupMembershipArrayOutput) ToGroupMembershipArrayOutput ¶ added in v4.20.0
func (o GroupMembershipArrayOutput) ToGroupMembershipArrayOutput() GroupMembershipArrayOutput
func (GroupMembershipArrayOutput) ToGroupMembershipArrayOutputWithContext ¶ added in v4.20.0
func (o GroupMembershipArrayOutput) ToGroupMembershipArrayOutputWithContext(ctx context.Context) GroupMembershipArrayOutput
type GroupMembershipInput ¶ added in v4.20.0
type GroupMembershipInput interface { pulumi.Input ToGroupMembershipOutput() GroupMembershipOutput ToGroupMembershipOutputWithContext(ctx context.Context) GroupMembershipOutput }
type GroupMembershipMap ¶ added in v4.20.0
type GroupMembershipMap map[string]GroupMembershipInput
func (GroupMembershipMap) ElementType ¶ added in v4.20.0
func (GroupMembershipMap) ElementType() reflect.Type
func (GroupMembershipMap) ToGroupMembershipMapOutput ¶ added in v4.20.0
func (i GroupMembershipMap) ToGroupMembershipMapOutput() GroupMembershipMapOutput
func (GroupMembershipMap) ToGroupMembershipMapOutputWithContext ¶ added in v4.20.0
func (i GroupMembershipMap) ToGroupMembershipMapOutputWithContext(ctx context.Context) GroupMembershipMapOutput
type GroupMembershipMapInput ¶ added in v4.20.0
type GroupMembershipMapInput interface { pulumi.Input ToGroupMembershipMapOutput() GroupMembershipMapOutput ToGroupMembershipMapOutputWithContext(context.Context) GroupMembershipMapOutput }
GroupMembershipMapInput is an input type that accepts GroupMembershipMap and GroupMembershipMapOutput values. You can construct a concrete instance of `GroupMembershipMapInput` via:
GroupMembershipMap{ "key": GroupMembershipArgs{...} }
type GroupMembershipMapOutput ¶ added in v4.20.0
type GroupMembershipMapOutput struct{ *pulumi.OutputState }
func (GroupMembershipMapOutput) ElementType ¶ added in v4.20.0
func (GroupMembershipMapOutput) ElementType() reflect.Type
func (GroupMembershipMapOutput) MapIndex ¶ added in v4.20.0
func (o GroupMembershipMapOutput) MapIndex(k pulumi.StringInput) GroupMembershipOutput
func (GroupMembershipMapOutput) ToGroupMembershipMapOutput ¶ added in v4.20.0
func (o GroupMembershipMapOutput) ToGroupMembershipMapOutput() GroupMembershipMapOutput
func (GroupMembershipMapOutput) ToGroupMembershipMapOutputWithContext ¶ added in v4.20.0
func (o GroupMembershipMapOutput) ToGroupMembershipMapOutputWithContext(ctx context.Context) GroupMembershipMapOutput
type GroupMembershipOutput ¶ added in v4.20.0
type GroupMembershipOutput struct{ *pulumi.OutputState }
func (GroupMembershipOutput) ElementType ¶ added in v4.20.0
func (GroupMembershipOutput) ElementType() reflect.Type
func (GroupMembershipOutput) ToGroupMembershipOutput ¶ added in v4.20.0
func (o GroupMembershipOutput) ToGroupMembershipOutput() GroupMembershipOutput
func (GroupMembershipOutput) ToGroupMembershipOutputWithContext ¶ added in v4.20.0
func (o GroupMembershipOutput) ToGroupMembershipOutputWithContext(ctx context.Context) GroupMembershipOutput
func (GroupMembershipOutput) ToGroupMembershipPtrOutput ¶ added in v4.20.0
func (o GroupMembershipOutput) ToGroupMembershipPtrOutput() GroupMembershipPtrOutput
func (GroupMembershipOutput) ToGroupMembershipPtrOutputWithContext ¶ added in v4.20.0
func (o GroupMembershipOutput) ToGroupMembershipPtrOutputWithContext(ctx context.Context) GroupMembershipPtrOutput
type GroupMembershipPtrInput ¶ added in v4.20.0
type GroupMembershipPtrInput interface { pulumi.Input ToGroupMembershipPtrOutput() GroupMembershipPtrOutput ToGroupMembershipPtrOutputWithContext(ctx context.Context) GroupMembershipPtrOutput }
type GroupMembershipPtrOutput ¶ added in v4.20.0
type GroupMembershipPtrOutput struct{ *pulumi.OutputState }
func (GroupMembershipPtrOutput) Elem ¶ added in v4.20.0
func (o GroupMembershipPtrOutput) Elem() GroupMembershipOutput
func (GroupMembershipPtrOutput) ElementType ¶ added in v4.20.0
func (GroupMembershipPtrOutput) ElementType() reflect.Type
func (GroupMembershipPtrOutput) ToGroupMembershipPtrOutput ¶ added in v4.20.0
func (o GroupMembershipPtrOutput) ToGroupMembershipPtrOutput() GroupMembershipPtrOutput
func (GroupMembershipPtrOutput) ToGroupMembershipPtrOutputWithContext ¶ added in v4.20.0
func (o GroupMembershipPtrOutput) ToGroupMembershipPtrOutputWithContext(ctx context.Context) GroupMembershipPtrOutput
type GroupMembershipState ¶ added in v4.20.0
type GroupMembershipState struct { 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 // The name of the group in which the member will be added. GroupName pulumi.StringPtrInput // The name of the member to add to the group. MemberName pulumi.StringPtrInput // The namespace. Defaults to `default`. Currently only `default` is supported. Namespace pulumi.StringPtrInput }
func (GroupMembershipState) ElementType ¶ added in v4.20.0
func (GroupMembershipState) ElementType() reflect.Type
type GroupOutput ¶
type GroupOutput struct{ *pulumi.OutputState }
func (GroupOutput) ElementType ¶
func (GroupOutput) ElementType() reflect.Type
func (GroupOutput) ToGroupOutput ¶
func (o GroupOutput) ToGroupOutput() GroupOutput
func (GroupOutput) ToGroupOutputWithContext ¶
func (o GroupOutput) ToGroupOutputWithContext(ctx context.Context) GroupOutput
func (GroupOutput) ToGroupPtrOutput ¶
func (o GroupOutput) ToGroupPtrOutput() GroupPtrOutput
func (GroupOutput) ToGroupPtrOutputWithContext ¶
func (o GroupOutput) ToGroupPtrOutputWithContext(ctx context.Context) GroupPtrOutput
type GroupPtrInput ¶
type GroupPtrInput interface { pulumi.Input ToGroupPtrOutput() GroupPtrOutput ToGroupPtrOutputWithContext(ctx context.Context) GroupPtrOutput }
type GroupPtrOutput ¶
type GroupPtrOutput struct{ *pulumi.OutputState }
func (GroupPtrOutput) Elem ¶ added in v4.15.0
func (o GroupPtrOutput) Elem() GroupOutput
func (GroupPtrOutput) ElementType ¶
func (GroupPtrOutput) ElementType() reflect.Type
func (GroupPtrOutput) ToGroupPtrOutput ¶
func (o GroupPtrOutput) ToGroupPtrOutput() GroupPtrOutput
func (GroupPtrOutput) ToGroupPtrOutputWithContext ¶
func (o GroupPtrOutput) ToGroupPtrOutputWithContext(ctx context.Context) GroupPtrOutput
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
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/quicksight" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := quicksight.NewUser(ctx, "example", &quicksight.UserArgs{ Email: pulumi.String("author@example.com"), IdentityType: pulumi.String("IAM"), UserName: pulumi.String("an-author"), UserRole: pulumi.String("AUTHOR"), }) if err != nil { return err } return nil }) }
```
## Import
Importing is currently not supported on this resource.
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.
func (*User) ElementType ¶
func (*User) ToUserOutput ¶
func (i *User) ToUserOutput() UserOutput
func (*User) ToUserOutputWithContext ¶
func (i *User) ToUserOutputWithContext(ctx context.Context) UserOutput
func (*User) ToUserPtrOutput ¶
func (i *User) ToUserPtrOutput() UserPtrOutput
func (*User) ToUserPtrOutputWithContext ¶
func (i *User) ToUserPtrOutputWithContext(ctx context.Context) UserPtrOutput
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 ¶
type UserArray ¶
type UserArray []UserInput
func (UserArray) ElementType ¶
func (UserArray) ToUserArrayOutput ¶
func (i UserArray) ToUserArrayOutput() UserArrayOutput
func (UserArray) ToUserArrayOutputWithContext ¶
func (i UserArray) ToUserArrayOutputWithContext(ctx context.Context) UserArrayOutput
type UserArrayInput ¶
type UserArrayInput interface { pulumi.Input ToUserArrayOutput() UserArrayOutput ToUserArrayOutputWithContext(context.Context) UserArrayOutput }
UserArrayInput is an input type that accepts UserArray and UserArrayOutput values. You can construct a concrete instance of `UserArrayInput` via:
UserArray{ UserArgs{...} }
type UserArrayOutput ¶
type UserArrayOutput struct{ *pulumi.OutputState }
func (UserArrayOutput) ElementType ¶
func (UserArrayOutput) ElementType() reflect.Type
func (UserArrayOutput) Index ¶
func (o UserArrayOutput) Index(i pulumi.IntInput) UserOutput
func (UserArrayOutput) ToUserArrayOutput ¶
func (o UserArrayOutput) ToUserArrayOutput() UserArrayOutput
func (UserArrayOutput) ToUserArrayOutputWithContext ¶
func (o UserArrayOutput) ToUserArrayOutputWithContext(ctx context.Context) UserArrayOutput
type UserInput ¶
type UserInput interface { pulumi.Input ToUserOutput() UserOutput ToUserOutputWithContext(ctx context.Context) UserOutput }
type UserMap ¶
func (UserMap) ElementType ¶
func (UserMap) ToUserMapOutput ¶
func (i UserMap) ToUserMapOutput() UserMapOutput
func (UserMap) ToUserMapOutputWithContext ¶
func (i UserMap) ToUserMapOutputWithContext(ctx context.Context) UserMapOutput
type UserMapInput ¶
type UserMapInput interface { pulumi.Input ToUserMapOutput() UserMapOutput ToUserMapOutputWithContext(context.Context) UserMapOutput }
UserMapInput is an input type that accepts UserMap and UserMapOutput values. You can construct a concrete instance of `UserMapInput` via:
UserMap{ "key": UserArgs{...} }
type UserMapOutput ¶
type UserMapOutput struct{ *pulumi.OutputState }
func (UserMapOutput) ElementType ¶
func (UserMapOutput) ElementType() reflect.Type
func (UserMapOutput) MapIndex ¶
func (o UserMapOutput) MapIndex(k pulumi.StringInput) UserOutput
func (UserMapOutput) ToUserMapOutput ¶
func (o UserMapOutput) ToUserMapOutput() UserMapOutput
func (UserMapOutput) ToUserMapOutputWithContext ¶
func (o UserMapOutput) ToUserMapOutputWithContext(ctx context.Context) UserMapOutput
type UserOutput ¶
type UserOutput struct{ *pulumi.OutputState }
func (UserOutput) ElementType ¶
func (UserOutput) ElementType() reflect.Type
func (UserOutput) ToUserOutput ¶
func (o UserOutput) ToUserOutput() UserOutput
func (UserOutput) ToUserOutputWithContext ¶
func (o UserOutput) ToUserOutputWithContext(ctx context.Context) UserOutput
func (UserOutput) ToUserPtrOutput ¶
func (o UserOutput) ToUserPtrOutput() UserPtrOutput
func (UserOutput) ToUserPtrOutputWithContext ¶
func (o UserOutput) ToUserPtrOutputWithContext(ctx context.Context) UserPtrOutput
type UserPtrInput ¶
type UserPtrInput interface { pulumi.Input ToUserPtrOutput() UserPtrOutput ToUserPtrOutputWithContext(ctx context.Context) UserPtrOutput }
type UserPtrOutput ¶
type UserPtrOutput struct{ *pulumi.OutputState }
func (UserPtrOutput) Elem ¶ added in v4.15.0
func (o UserPtrOutput) Elem() UserOutput
func (UserPtrOutput) ElementType ¶
func (UserPtrOutput) ElementType() reflect.Type
func (UserPtrOutput) ToUserPtrOutput ¶
func (o UserPtrOutput) ToUserPtrOutput() UserPtrOutput
func (UserPtrOutput) ToUserPtrOutputWithContext ¶
func (o UserPtrOutput) ToUserPtrOutputWithContext(ctx context.Context) UserPtrOutput
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 }