IamPolicyAssignment class
Resource for managing an AWS QuickSight IAM Policy Assignment.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.quicksight.IamPolicyAssignment("example", {
identities: {
users: [exampleAwsQuicksightUser.userName],
},
assignmentName: "example",
assignmentStatus: "ENABLED",
policyArn: exampleAwsIamPolicy.arn,
});
import pulumi
import pulumi_aws as aws
example = aws.quicksight.IamPolicyAssignment("example",
identities={
"users": [example_aws_quicksight_user["userName"]],
},
assignment_name="example",
assignment_status="ENABLED",
policy_arn=example_aws_iam_policy["arn"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Quicksight.IamPolicyAssignment("example", new()
{
Identities = new Aws.Quicksight.Inputs.IamPolicyAssignmentIdentitiesArgs
{
Users = new[]
{
exampleAwsQuicksightUser.UserName,
},
},
AssignmentName = "example",
AssignmentStatus = "ENABLED",
PolicyArn = exampleAwsIamPolicy.Arn,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/quicksight"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := quicksight.NewIamPolicyAssignment(ctx, "example", &quicksight.IamPolicyAssignmentArgs{
Identities: &quicksight.IamPolicyAssignmentIdentitiesArgs{
Users: pulumi.StringArray{
exampleAwsQuicksightUser.UserName,
},
},
AssignmentName: pulumi.String("example"),
AssignmentStatus: pulumi.String("ENABLED"),
PolicyArn: pulumi.Any(exampleAwsIamPolicy.Arn),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_quicksight_iampolicyassignment" "example" {
identities = {
users = [exampleAwsQuicksightUser.userName]
}
assignment_name = "example"
assignment_status = "ENABLED"
policy_arn = exampleAwsIamPolicy.arn
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.IamPolicyAssignment;
import com.pulumi.aws.quicksight.IamPolicyAssignmentArgs;
import com.pulumi.aws.quicksight.inputs.IamPolicyAssignmentIdentitiesArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 IamPolicyAssignment("example", IamPolicyAssignmentArgs.builder()
.identities(IamPolicyAssignmentIdentitiesArgs.builder()
.users(exampleAwsQuicksightUser.userName())
.build())
.assignmentName("example")
.assignmentStatus("ENABLED")
.policyArn(exampleAwsIamPolicy.arn())
.build());
}
}
resources:
example:
type: aws:quicksight:IamPolicyAssignment
properties:
identities:
users:
- ${exampleAwsQuicksightUser.userName}
assignmentName: example
assignmentStatus: ENABLED
policyArn: ${exampleAwsIamPolicy.arn}
Import
Using pulumi import, import QuickSight IAM Policy Assignment using the AWS account ID, namespace, and assignment name separated by commas (,). For example:
$ pulumi import aws:quicksight/iamPolicyAssignment:IamPolicyAssignment example 123456789012,default,example
Constructors
- IamPolicyAssignment(String name, {IamPolicyAssignmentArgs? args, CustomResourceOptions? options})
-
Creates a new IamPolicyAssignment.
nameThe Pulumi resource name.argsArguments used to configure this IamPolicyAssignment. The set of arguments for IamPolicyAssignment.optionsResource options controlling this resource's behavior. - IamPolicyAssignment.reference(String urn)
- Creates a typed reference to an existing IamPolicyAssignment resource.
Properties
-
assignmentId
↔ Output<
String> -
Assignment ID.
latefinal
-
assignmentName
↔ Output<
String> -
Name of the assignment.
latefinal
-
assignmentStatus
↔ Output<
String> -
Status of the assignment. Valid values are
ENABLED,DISABLED, andDRAFT.latefinal -
awsAccountId
↔ Output<
String> -
AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
identities
↔ Output<
IamPolicyAssignmentIdentities?> -
Amazon QuickSight users, groups, or both to assign the policy to. See
identitiesblock.latefinal - isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
namespace
↔ Output<
String> -
Namespace that contains the assignment. Defaults to
default.latefinal -
policyArn
↔ Output<
String?> -
ARN of the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {IamPolicyAssignmentState? state, CustomResourceOptions? options}) → IamPolicyAssignment -
Gets an existing IamPolicyAssignment resource's state with the given
nameandid.