ssoadmin

package
v3.24.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 19, 2021 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccountAssignment added in v3.24.0

type AccountAssignment struct {
	pulumi.CustomResourceState

	// The Amazon Resource Name (ARN) of the SSO Instance.
	InstanceArn pulumi.StringOutput `pulumi:"instanceArn"`
	// The Amazon Resource Name (ARN) of the Permission Set that the admin wants to grant the principal access to.
	PermissionSetArn pulumi.StringOutput `pulumi:"permissionSetArn"`
	// An identifier for an object in SSO, such as a user or group. PrincipalIds are GUIDs (For example, `f81d4fae-7dec-11d0-a765-00a0c91e6bf6`).
	PrincipalId pulumi.StringOutput `pulumi:"principalId"`
	// The entity type for which the assignment will be created. Valid values: `USER`, `GROUP`.
	PrincipalType pulumi.StringOutput `pulumi:"principalType"`
	// An AWS account identifier, typically a 10-12 digit string.
	TargetId pulumi.StringOutput `pulumi:"targetId"`
	// The entity type for which the assignment will be created. Valid values: `AWS_ACCOUNT`.
	TargetType pulumi.StringPtrOutput `pulumi:"targetType"`
}

Provides a Single Sign-On (SSO) Account Assignment resource

## Import

SSO Account Assignments can be imported using the `principal_id`, `principal_type`, `target_id`, `target_type`, `permission_set_arn`, `instance_arn` separated by commas (`,`) e.g.

```sh

$ pulumi import aws:ssoadmin/accountAssignment:AccountAssignment example f81d4fae-7dec-11d0-a765-00a0c91e6bf6,GROUP,1234567890,AWS_ACCOUNT,arn:aws:sso:::permissionSet/ssoins-0123456789abcdef/ps-0123456789abcdef,arn:aws:sso:::instance/ssoins-0123456789abcdef

```

func GetAccountAssignment added in v3.24.0

func GetAccountAssignment(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AccountAssignmentState, opts ...pulumi.ResourceOption) (*AccountAssignment, error)

GetAccountAssignment gets an existing AccountAssignment 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 NewAccountAssignment added in v3.24.0

func NewAccountAssignment(ctx *pulumi.Context,
	name string, args *AccountAssignmentArgs, opts ...pulumi.ResourceOption) (*AccountAssignment, error)

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

func (*AccountAssignment) ElementType added in v3.24.0

func (*AccountAssignment) ElementType() reflect.Type

func (*AccountAssignment) ToAccountAssignmentOutput added in v3.24.0

func (i *AccountAssignment) ToAccountAssignmentOutput() AccountAssignmentOutput

func (*AccountAssignment) ToAccountAssignmentOutputWithContext added in v3.24.0

func (i *AccountAssignment) ToAccountAssignmentOutputWithContext(ctx context.Context) AccountAssignmentOutput

type AccountAssignmentArgs added in v3.24.0

type AccountAssignmentArgs struct {
	// The Amazon Resource Name (ARN) of the SSO Instance.
	InstanceArn pulumi.StringInput
	// The Amazon Resource Name (ARN) of the Permission Set that the admin wants to grant the principal access to.
	PermissionSetArn pulumi.StringInput
	// An identifier for an object in SSO, such as a user or group. PrincipalIds are GUIDs (For example, `f81d4fae-7dec-11d0-a765-00a0c91e6bf6`).
	PrincipalId pulumi.StringInput
	// The entity type for which the assignment will be created. Valid values: `USER`, `GROUP`.
	PrincipalType pulumi.StringInput
	// An AWS account identifier, typically a 10-12 digit string.
	TargetId pulumi.StringInput
	// The entity type for which the assignment will be created. Valid values: `AWS_ACCOUNT`.
	TargetType pulumi.StringPtrInput
}

The set of arguments for constructing a AccountAssignment resource.

func (AccountAssignmentArgs) ElementType added in v3.24.0

func (AccountAssignmentArgs) ElementType() reflect.Type

type AccountAssignmentInput added in v3.24.0

type AccountAssignmentInput interface {
	pulumi.Input

	ToAccountAssignmentOutput() AccountAssignmentOutput
	ToAccountAssignmentOutputWithContext(ctx context.Context) AccountAssignmentOutput
}

type AccountAssignmentOutput added in v3.24.0

type AccountAssignmentOutput struct {
	*pulumi.OutputState
}

func (AccountAssignmentOutput) ElementType added in v3.24.0

func (AccountAssignmentOutput) ElementType() reflect.Type

func (AccountAssignmentOutput) ToAccountAssignmentOutput added in v3.24.0

func (o AccountAssignmentOutput) ToAccountAssignmentOutput() AccountAssignmentOutput

func (AccountAssignmentOutput) ToAccountAssignmentOutputWithContext added in v3.24.0

func (o AccountAssignmentOutput) ToAccountAssignmentOutputWithContext(ctx context.Context) AccountAssignmentOutput

type AccountAssignmentState added in v3.24.0

type AccountAssignmentState struct {
	// The Amazon Resource Name (ARN) of the SSO Instance.
	InstanceArn pulumi.StringPtrInput
	// The Amazon Resource Name (ARN) of the Permission Set that the admin wants to grant the principal access to.
	PermissionSetArn pulumi.StringPtrInput
	// An identifier for an object in SSO, such as a user or group. PrincipalIds are GUIDs (For example, `f81d4fae-7dec-11d0-a765-00a0c91e6bf6`).
	PrincipalId pulumi.StringPtrInput
	// The entity type for which the assignment will be created. Valid values: `USER`, `GROUP`.
	PrincipalType pulumi.StringPtrInput
	// An AWS account identifier, typically a 10-12 digit string.
	TargetId pulumi.StringPtrInput
	// The entity type for which the assignment will be created. Valid values: `AWS_ACCOUNT`.
	TargetType pulumi.StringPtrInput
}

func (AccountAssignmentState) ElementType added in v3.24.0

func (AccountAssignmentState) ElementType() reflect.Type

type GetInstancesResult

type GetInstancesResult struct {
	// Set of Amazon Resource Names (ARNs) of the SSO Instances.
	Arns []string `pulumi:"arns"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// Set of identifiers of the identity stores connected to the SSO Instances.
	IdentityStoreIds []string `pulumi:"identityStoreIds"`
}

A collection of values returned by getInstances.

func GetInstances

func GetInstances(ctx *pulumi.Context, opts ...pulumi.InvokeOption) (*GetInstancesResult, error)

Use this data source to get ARNs and Identity Store IDs of Single Sign-On (SSO) Instances.

type LookupPermissionSetArgs

type LookupPermissionSetArgs struct {
	// The Amazon Resource Name (ARN) of the permission set.
	Arn *string `pulumi:"arn"`
	// The Amazon Resource Name (ARN) of the SSO Instance associated with the permission set.
	InstanceArn string `pulumi:"instanceArn"`
	// The name of the SSO Permission Set.
	Name *string `pulumi:"name"`
	// Key-value map of resource tags.
	Tags map[string]string `pulumi:"tags"`
}

A collection of arguments for invoking getPermissionSet.

type LookupPermissionSetResult

type LookupPermissionSetResult struct {
	Arn         string `pulumi:"arn"`
	CreatedDate string `pulumi:"createdDate"`
	// The description of the Permission Set.
	Description string `pulumi:"description"`
	// The provider-assigned unique ID for this managed resource.
	Id          string `pulumi:"id"`
	InstanceArn string `pulumi:"instanceArn"`
	Name        string `pulumi:"name"`
	// The relay state URL used to redirect users within the application during the federation authentication process.
	RelayState string `pulumi:"relayState"`
	// The length of time that the application user sessions are valid in the ISO-8601 standard.
	SessionDuration string `pulumi:"sessionDuration"`
	// Key-value map of resource tags.
	Tags map[string]string `pulumi:"tags"`
}

A collection of values returned by getPermissionSet.

func LookupPermissionSet

func LookupPermissionSet(ctx *pulumi.Context, args *LookupPermissionSetArgs, opts ...pulumi.InvokeOption) (*LookupPermissionSetResult, error)

Use this data source to get a Single Sign-On (SSO) Permission Set.

type ManagedPolicyAttachment

type ManagedPolicyAttachment struct {
	pulumi.CustomResourceState

	// The Amazon Resource Name (ARN) of the SSO Instance under which the operation will be executed.
	InstanceArn pulumi.StringOutput `pulumi:"instanceArn"`
	// The IAM managed policy Amazon Resource Name (ARN) to be attached to the Permission Set.
	ManagedPolicyArn pulumi.StringOutput `pulumi:"managedPolicyArn"`
	// The name of the IAM Managed Policy.
	ManagedPolicyName pulumi.StringOutput `pulumi:"managedPolicyName"`
	// The Amazon Resource Name (ARN) of the Permission Set.
	PermissionSetArn pulumi.StringOutput `pulumi:"permissionSetArn"`
}

Provides an IAM managed policy for a Single Sign-On (SSO) Permission Set resource

> **NOTE:** Creating this resource will automatically [Provision the Permission Set](https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_ProvisionPermissionSet.html) to apply the corresponding updates to all assigned accounts.

## Import

SSO Managed Policy Attachments can be imported using the `managed_policy_arn`, `permission_set_arn`, and `instance_arn` separated by a comma (`,`) e.g.

```sh

$ pulumi import aws:ssoadmin/managedPolicyAttachment:ManagedPolicyAttachment example arn:aws:iam::aws:policy/AlexaForBusinessDeviceSetup,arn:aws:sso:::permissionSet/ssoins-2938j0x8920sbj72/ps-80383020jr9302rk,arn:aws:sso:::instance/ssoins-2938j0x8920sbj72

```

func GetManagedPolicyAttachment

func GetManagedPolicyAttachment(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ManagedPolicyAttachmentState, opts ...pulumi.ResourceOption) (*ManagedPolicyAttachment, error)

GetManagedPolicyAttachment gets an existing ManagedPolicyAttachment 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 NewManagedPolicyAttachment

func NewManagedPolicyAttachment(ctx *pulumi.Context,
	name string, args *ManagedPolicyAttachmentArgs, opts ...pulumi.ResourceOption) (*ManagedPolicyAttachment, error)

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

func (*ManagedPolicyAttachment) ElementType

func (*ManagedPolicyAttachment) ElementType() reflect.Type

func (*ManagedPolicyAttachment) ToManagedPolicyAttachmentOutput

func (i *ManagedPolicyAttachment) ToManagedPolicyAttachmentOutput() ManagedPolicyAttachmentOutput

func (*ManagedPolicyAttachment) ToManagedPolicyAttachmentOutputWithContext

func (i *ManagedPolicyAttachment) ToManagedPolicyAttachmentOutputWithContext(ctx context.Context) ManagedPolicyAttachmentOutput

type ManagedPolicyAttachmentArgs

type ManagedPolicyAttachmentArgs struct {
	// The Amazon Resource Name (ARN) of the SSO Instance under which the operation will be executed.
	InstanceArn pulumi.StringInput
	// The IAM managed policy Amazon Resource Name (ARN) to be attached to the Permission Set.
	ManagedPolicyArn pulumi.StringInput
	// The Amazon Resource Name (ARN) of the Permission Set.
	PermissionSetArn pulumi.StringInput
}

The set of arguments for constructing a ManagedPolicyAttachment resource.

func (ManagedPolicyAttachmentArgs) ElementType

type ManagedPolicyAttachmentInput

type ManagedPolicyAttachmentInput interface {
	pulumi.Input

	ToManagedPolicyAttachmentOutput() ManagedPolicyAttachmentOutput
	ToManagedPolicyAttachmentOutputWithContext(ctx context.Context) ManagedPolicyAttachmentOutput
}

type ManagedPolicyAttachmentOutput

type ManagedPolicyAttachmentOutput struct {
	*pulumi.OutputState
}

func (ManagedPolicyAttachmentOutput) ElementType

func (ManagedPolicyAttachmentOutput) ToManagedPolicyAttachmentOutput

func (o ManagedPolicyAttachmentOutput) ToManagedPolicyAttachmentOutput() ManagedPolicyAttachmentOutput

func (ManagedPolicyAttachmentOutput) ToManagedPolicyAttachmentOutputWithContext

func (o ManagedPolicyAttachmentOutput) ToManagedPolicyAttachmentOutputWithContext(ctx context.Context) ManagedPolicyAttachmentOutput

type ManagedPolicyAttachmentState

type ManagedPolicyAttachmentState struct {
	// The Amazon Resource Name (ARN) of the SSO Instance under which the operation will be executed.
	InstanceArn pulumi.StringPtrInput
	// The IAM managed policy Amazon Resource Name (ARN) to be attached to the Permission Set.
	ManagedPolicyArn pulumi.StringPtrInput
	// The name of the IAM Managed Policy.
	ManagedPolicyName pulumi.StringPtrInput
	// The Amazon Resource Name (ARN) of the Permission Set.
	PermissionSetArn pulumi.StringPtrInput
}

func (ManagedPolicyAttachmentState) ElementType

type PermissionSet

type PermissionSet struct {
	pulumi.CustomResourceState

	// The Amazon Resource Name (ARN) of the Permission Set.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The date the Permission Set was created in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8).
	CreatedDate pulumi.StringOutput `pulumi:"createdDate"`
	// The description of the Permission Set.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The Amazon Resource Name (ARN) of the SSO Instance under which the operation will be executed.
	InstanceArn pulumi.StringOutput `pulumi:"instanceArn"`
	// The name of the Permission Set.
	Name pulumi.StringOutput `pulumi:"name"`
	// The relay state URL used to redirect users within the application during the federation authentication process.
	RelayState pulumi.StringPtrOutput `pulumi:"relayState"`
	// The length of time that the application user sessions are valid in the ISO-8601 standard. Default: `PT1H`.
	SessionDuration pulumi.StringPtrOutput `pulumi:"sessionDuration"`
	// Key-value map of resource tags.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
}

Provides a Single Sign-On (SSO) Permission Set resource

> **NOTE:** Updating this resource will automatically [Provision the Permission Set](https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_ProvisionPermissionSet.html) to apply the corresponding updates to all assigned accounts.

## Import

SSO Permission Sets can be imported using the `arn` and `instance_arn` separated by a comma (`,`) e.g.

```sh

$ pulumi import aws:ssoadmin/permissionSet:PermissionSet example arn:aws:sso:::permissionSet/ssoins-2938j0x8920sbj72/ps-80383020jr9302rk,arn:aws:sso:::instance/ssoins-2938j0x8920sbj72

```

func GetPermissionSet

func GetPermissionSet(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *PermissionSetState, opts ...pulumi.ResourceOption) (*PermissionSet, error)

GetPermissionSet gets an existing PermissionSet 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 NewPermissionSet

func NewPermissionSet(ctx *pulumi.Context,
	name string, args *PermissionSetArgs, opts ...pulumi.ResourceOption) (*PermissionSet, error)

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

func (*PermissionSet) ElementType

func (*PermissionSet) ElementType() reflect.Type

func (*PermissionSet) ToPermissionSetOutput

func (i *PermissionSet) ToPermissionSetOutput() PermissionSetOutput

func (*PermissionSet) ToPermissionSetOutputWithContext

func (i *PermissionSet) ToPermissionSetOutputWithContext(ctx context.Context) PermissionSetOutput

type PermissionSetArgs

type PermissionSetArgs struct {
	// The description of the Permission Set.
	Description pulumi.StringPtrInput
	// The Amazon Resource Name (ARN) of the SSO Instance under which the operation will be executed.
	InstanceArn pulumi.StringInput
	// The name of the Permission Set.
	Name pulumi.StringPtrInput
	// The relay state URL used to redirect users within the application during the federation authentication process.
	RelayState pulumi.StringPtrInput
	// The length of time that the application user sessions are valid in the ISO-8601 standard. Default: `PT1H`.
	SessionDuration pulumi.StringPtrInput
	// Key-value map of resource tags.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a PermissionSet resource.

func (PermissionSetArgs) ElementType

func (PermissionSetArgs) ElementType() reflect.Type

type PermissionSetInlinePolicy

type PermissionSetInlinePolicy struct {
	pulumi.CustomResourceState

	// The IAM inline policy to attach to a Permission Set.
	InlinePolicy pulumi.StringOutput `pulumi:"inlinePolicy"`
	// The Amazon Resource Name (ARN) of the SSO Instance under which the operation will be executed.
	InstanceArn pulumi.StringOutput `pulumi:"instanceArn"`
	// The Amazon Resource Name (ARN) of the Permission Set.
	PermissionSetArn pulumi.StringOutput `pulumi:"permissionSetArn"`
}

Provides an IAM inline policy for a Single Sign-On (SSO) Permission Set resource

> **NOTE:** AWS Single Sign-On (SSO) only supports one IAM inline policy per `ssoadmin.PermissionSet` resource. Creating or updating this resource will automatically [Provision the Permission Set](https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_ProvisionPermissionSet.html) to apply the corresponding updates to all assigned accounts.

## Import

SSO Permission Set Inline Policies can be imported using the `permission_set_arn` and `instance_arn` separated by a comma (`,`) e.g.

```sh

$ pulumi import aws:ssoadmin/permissionSetInlinePolicy:PermissionSetInlinePolicy example arn:aws:sso:::permissionSet/ssoins-2938j0x8920sbj72/ps-80383020jr9302rk,arn:aws:sso:::instance/ssoins-2938j0x8920sbj72

```

func GetPermissionSetInlinePolicy

func GetPermissionSetInlinePolicy(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *PermissionSetInlinePolicyState, opts ...pulumi.ResourceOption) (*PermissionSetInlinePolicy, error)

GetPermissionSetInlinePolicy gets an existing PermissionSetInlinePolicy 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 NewPermissionSetInlinePolicy

func NewPermissionSetInlinePolicy(ctx *pulumi.Context,
	name string, args *PermissionSetInlinePolicyArgs, opts ...pulumi.ResourceOption) (*PermissionSetInlinePolicy, error)

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

func (*PermissionSetInlinePolicy) ElementType

func (*PermissionSetInlinePolicy) ElementType() reflect.Type

func (*PermissionSetInlinePolicy) ToPermissionSetInlinePolicyOutput

func (i *PermissionSetInlinePolicy) ToPermissionSetInlinePolicyOutput() PermissionSetInlinePolicyOutput

func (*PermissionSetInlinePolicy) ToPermissionSetInlinePolicyOutputWithContext

func (i *PermissionSetInlinePolicy) ToPermissionSetInlinePolicyOutputWithContext(ctx context.Context) PermissionSetInlinePolicyOutput

type PermissionSetInlinePolicyArgs

type PermissionSetInlinePolicyArgs struct {
	// The IAM inline policy to attach to a Permission Set.
	InlinePolicy pulumi.StringInput
	// The Amazon Resource Name (ARN) of the SSO Instance under which the operation will be executed.
	InstanceArn pulumi.StringInput
	// The Amazon Resource Name (ARN) of the Permission Set.
	PermissionSetArn pulumi.StringInput
}

The set of arguments for constructing a PermissionSetInlinePolicy resource.

func (PermissionSetInlinePolicyArgs) ElementType

type PermissionSetInlinePolicyInput

type PermissionSetInlinePolicyInput interface {
	pulumi.Input

	ToPermissionSetInlinePolicyOutput() PermissionSetInlinePolicyOutput
	ToPermissionSetInlinePolicyOutputWithContext(ctx context.Context) PermissionSetInlinePolicyOutput
}

type PermissionSetInlinePolicyOutput

type PermissionSetInlinePolicyOutput struct {
	*pulumi.OutputState
}

func (PermissionSetInlinePolicyOutput) ElementType

func (PermissionSetInlinePolicyOutput) ToPermissionSetInlinePolicyOutput

func (o PermissionSetInlinePolicyOutput) ToPermissionSetInlinePolicyOutput() PermissionSetInlinePolicyOutput

func (PermissionSetInlinePolicyOutput) ToPermissionSetInlinePolicyOutputWithContext

func (o PermissionSetInlinePolicyOutput) ToPermissionSetInlinePolicyOutputWithContext(ctx context.Context) PermissionSetInlinePolicyOutput

type PermissionSetInlinePolicyState

type PermissionSetInlinePolicyState struct {
	// The IAM inline policy to attach to a Permission Set.
	InlinePolicy pulumi.StringPtrInput
	// The Amazon Resource Name (ARN) of the SSO Instance under which the operation will be executed.
	InstanceArn pulumi.StringPtrInput
	// The Amazon Resource Name (ARN) of the Permission Set.
	PermissionSetArn pulumi.StringPtrInput
}

func (PermissionSetInlinePolicyState) ElementType

type PermissionSetInput

type PermissionSetInput interface {
	pulumi.Input

	ToPermissionSetOutput() PermissionSetOutput
	ToPermissionSetOutputWithContext(ctx context.Context) PermissionSetOutput
}

type PermissionSetOutput

type PermissionSetOutput struct {
	*pulumi.OutputState
}

func (PermissionSetOutput) ElementType

func (PermissionSetOutput) ElementType() reflect.Type

func (PermissionSetOutput) ToPermissionSetOutput

func (o PermissionSetOutput) ToPermissionSetOutput() PermissionSetOutput

func (PermissionSetOutput) ToPermissionSetOutputWithContext

func (o PermissionSetOutput) ToPermissionSetOutputWithContext(ctx context.Context) PermissionSetOutput

type PermissionSetState

type PermissionSetState struct {
	// The Amazon Resource Name (ARN) of the Permission Set.
	Arn pulumi.StringPtrInput
	// The date the Permission Set was created in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8).
	CreatedDate pulumi.StringPtrInput
	// The description of the Permission Set.
	Description pulumi.StringPtrInput
	// The Amazon Resource Name (ARN) of the SSO Instance under which the operation will be executed.
	InstanceArn pulumi.StringPtrInput
	// The name of the Permission Set.
	Name pulumi.StringPtrInput
	// The relay state URL used to redirect users within the application during the federation authentication process.
	RelayState pulumi.StringPtrInput
	// The length of time that the application user sessions are valid in the ISO-8601 standard. Default: `PT1H`.
	SessionDuration pulumi.StringPtrInput
	// Key-value map of resource tags.
	Tags pulumi.StringMapInput
}

func (PermissionSetState) ElementType

func (PermissionSetState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL