organizations

package
v0.104.0 Latest Latest
Warning

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

Go to latest
Published: Apr 30, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source
const (
	AccountJoinedMethodInvited = AccountJoinedMethod("INVITED")
	AccountJoinedMethodCreated = AccountJoinedMethod("CREATED")
)
View Source
const (
	AccountStatusActive         = AccountStatus("ACTIVE")
	AccountStatusSuspended      = AccountStatus("SUSPENDED")
	AccountStatusPendingClosure = AccountStatus("PENDING_CLOSURE")
)
View Source
const (
	OrganizationFeatureSetAll                 = OrganizationFeatureSet("ALL")
	OrganizationFeatureSetConsolidatedBilling = OrganizationFeatureSet("CONSOLIDATED_BILLING")
)
View Source
const (
	PolicyTypeServiceControlPolicy   = PolicyType("SERVICE_CONTROL_POLICY")
	PolicyTypeAiservicesOptOutPolicy = PolicyType("AISERVICES_OPT_OUT_POLICY")
	PolicyTypeBackupPolicy           = PolicyType("BACKUP_POLICY")
	PolicyTypeTagPolicy              = PolicyType("TAG_POLICY")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Account

type Account struct {
	pulumi.CustomResourceState

	// If the account was created successfully, the unique identifier (ID) of the new account.
	AccountId pulumi.StringOutput `pulumi:"accountId"`
	// The friendly name of the member account.
	AccountName pulumi.StringOutput `pulumi:"accountName"`
	// The Amazon Resource Name (ARN) of the account.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The email address of the owner to assign to the new member account.
	Email pulumi.StringOutput `pulumi:"email"`
	// The method by which the account joined the organization.
	JoinedMethod AccountJoinedMethodOutput `pulumi:"joinedMethod"`
	// The date the account became a part of the organization.
	JoinedTimestamp pulumi.StringOutput `pulumi:"joinedTimestamp"`
	// List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.
	ParentIds pulumi.StringArrayOutput `pulumi:"parentIds"`
	// The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified.
	RoleName pulumi.StringPtrOutput `pulumi:"roleName"`
	// The status of the account in the organization.
	Status AccountStatusOutput `pulumi:"status"`
	// A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value.
	Tags aws.TagArrayOutput `pulumi:"tags"`
}

You can use AWS::Organizations::Account to manage accounts in organization.

func GetAccount

func GetAccount(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AccountState, opts ...pulumi.ResourceOption) (*Account, error)

GetAccount gets an existing Account 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 NewAccount

func NewAccount(ctx *pulumi.Context,
	name string, args *AccountArgs, opts ...pulumi.ResourceOption) (*Account, error)

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

func (*Account) ElementType

func (*Account) ElementType() reflect.Type

func (*Account) ToAccountOutput

func (i *Account) ToAccountOutput() AccountOutput

func (*Account) ToAccountOutputWithContext

func (i *Account) ToAccountOutputWithContext(ctx context.Context) AccountOutput

type AccountArgs

type AccountArgs struct {
	// The friendly name of the member account.
	AccountName pulumi.StringPtrInput
	// The email address of the owner to assign to the new member account.
	Email pulumi.StringInput
	// List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.
	ParentIds pulumi.StringArrayInput
	// The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified.
	RoleName pulumi.StringPtrInput
	// A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value.
	Tags aws.TagArrayInput
}

The set of arguments for constructing a Account resource.

func (AccountArgs) ElementType

func (AccountArgs) ElementType() reflect.Type

type AccountInput

type AccountInput interface {
	pulumi.Input

	ToAccountOutput() AccountOutput
	ToAccountOutputWithContext(ctx context.Context) AccountOutput
}

type AccountJoinedMethod

type AccountJoinedMethod string

The method by which the account joined the organization.

type AccountJoinedMethodOutput

type AccountJoinedMethodOutput struct{ *pulumi.OutputState }

func (AccountJoinedMethodOutput) ElementType

func (AccountJoinedMethodOutput) ElementType() reflect.Type

func (AccountJoinedMethodOutput) ToAccountJoinedMethodOutput

func (o AccountJoinedMethodOutput) ToAccountJoinedMethodOutput() AccountJoinedMethodOutput

func (AccountJoinedMethodOutput) ToAccountJoinedMethodOutputWithContext

func (o AccountJoinedMethodOutput) ToAccountJoinedMethodOutputWithContext(ctx context.Context) AccountJoinedMethodOutput

func (AccountJoinedMethodOutput) ToAccountJoinedMethodPtrOutput

func (o AccountJoinedMethodOutput) ToAccountJoinedMethodPtrOutput() AccountJoinedMethodPtrOutput

func (AccountJoinedMethodOutput) ToAccountJoinedMethodPtrOutputWithContext

func (o AccountJoinedMethodOutput) ToAccountJoinedMethodPtrOutputWithContext(ctx context.Context) AccountJoinedMethodPtrOutput

func (AccountJoinedMethodOutput) ToStringOutput

func (o AccountJoinedMethodOutput) ToStringOutput() pulumi.StringOutput

func (AccountJoinedMethodOutput) ToStringOutputWithContext

func (o AccountJoinedMethodOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (AccountJoinedMethodOutput) ToStringPtrOutput

func (o AccountJoinedMethodOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (AccountJoinedMethodOutput) ToStringPtrOutputWithContext

func (o AccountJoinedMethodOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type AccountJoinedMethodPtrOutput

type AccountJoinedMethodPtrOutput struct{ *pulumi.OutputState }

func (AccountJoinedMethodPtrOutput) Elem

func (AccountJoinedMethodPtrOutput) ElementType

func (AccountJoinedMethodPtrOutput) ToAccountJoinedMethodPtrOutput

func (o AccountJoinedMethodPtrOutput) ToAccountJoinedMethodPtrOutput() AccountJoinedMethodPtrOutput

func (AccountJoinedMethodPtrOutput) ToAccountJoinedMethodPtrOutputWithContext

func (o AccountJoinedMethodPtrOutput) ToAccountJoinedMethodPtrOutputWithContext(ctx context.Context) AccountJoinedMethodPtrOutput

func (AccountJoinedMethodPtrOutput) ToStringPtrOutput

func (o AccountJoinedMethodPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (AccountJoinedMethodPtrOutput) ToStringPtrOutputWithContext

func (o AccountJoinedMethodPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type AccountOutput

type AccountOutput struct{ *pulumi.OutputState }

func (AccountOutput) AccountId

func (o AccountOutput) AccountId() pulumi.StringOutput

If the account was created successfully, the unique identifier (ID) of the new account.

func (AccountOutput) AccountName

func (o AccountOutput) AccountName() pulumi.StringOutput

The friendly name of the member account.

func (AccountOutput) Arn

The Amazon Resource Name (ARN) of the account.

func (AccountOutput) ElementType

func (AccountOutput) ElementType() reflect.Type

func (AccountOutput) Email

func (o AccountOutput) Email() pulumi.StringOutput

The email address of the owner to assign to the new member account.

func (AccountOutput) JoinedMethod

func (o AccountOutput) JoinedMethod() AccountJoinedMethodOutput

The method by which the account joined the organization.

func (AccountOutput) JoinedTimestamp

func (o AccountOutput) JoinedTimestamp() pulumi.StringOutput

The date the account became a part of the organization.

func (AccountOutput) ParentIds

func (o AccountOutput) ParentIds() pulumi.StringArrayOutput

List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.

func (AccountOutput) RoleName

func (o AccountOutput) RoleName() pulumi.StringPtrOutput

The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified.

func (AccountOutput) Status

The status of the account in the organization.

func (AccountOutput) Tags

func (o AccountOutput) Tags() aws.TagArrayOutput

A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value.

func (AccountOutput) ToAccountOutput

func (o AccountOutput) ToAccountOutput() AccountOutput

func (AccountOutput) ToAccountOutputWithContext

func (o AccountOutput) ToAccountOutputWithContext(ctx context.Context) AccountOutput

type AccountState

type AccountState struct {
}

func (AccountState) ElementType

func (AccountState) ElementType() reflect.Type

type AccountStatus

type AccountStatus string

The status of the account in the organization.

type AccountStatusOutput

type AccountStatusOutput struct{ *pulumi.OutputState }

func (AccountStatusOutput) ElementType

func (AccountStatusOutput) ElementType() reflect.Type

func (AccountStatusOutput) ToAccountStatusOutput

func (o AccountStatusOutput) ToAccountStatusOutput() AccountStatusOutput

func (AccountStatusOutput) ToAccountStatusOutputWithContext

func (o AccountStatusOutput) ToAccountStatusOutputWithContext(ctx context.Context) AccountStatusOutput

func (AccountStatusOutput) ToAccountStatusPtrOutput

func (o AccountStatusOutput) ToAccountStatusPtrOutput() AccountStatusPtrOutput

func (AccountStatusOutput) ToAccountStatusPtrOutputWithContext

func (o AccountStatusOutput) ToAccountStatusPtrOutputWithContext(ctx context.Context) AccountStatusPtrOutput

func (AccountStatusOutput) ToStringOutput

func (o AccountStatusOutput) ToStringOutput() pulumi.StringOutput

func (AccountStatusOutput) ToStringOutputWithContext

func (o AccountStatusOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (AccountStatusOutput) ToStringPtrOutput

func (o AccountStatusOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (AccountStatusOutput) ToStringPtrOutputWithContext

func (o AccountStatusOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type AccountStatusPtrOutput

type AccountStatusPtrOutput struct{ *pulumi.OutputState }

func (AccountStatusPtrOutput) Elem

func (AccountStatusPtrOutput) ElementType

func (AccountStatusPtrOutput) ElementType() reflect.Type

func (AccountStatusPtrOutput) ToAccountStatusPtrOutput

func (o AccountStatusPtrOutput) ToAccountStatusPtrOutput() AccountStatusPtrOutput

func (AccountStatusPtrOutput) ToAccountStatusPtrOutputWithContext

func (o AccountStatusPtrOutput) ToAccountStatusPtrOutputWithContext(ctx context.Context) AccountStatusPtrOutput

func (AccountStatusPtrOutput) ToStringPtrOutput

func (o AccountStatusPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (AccountStatusPtrOutput) ToStringPtrOutputWithContext

func (o AccountStatusPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type AccountTag

type AccountTag struct {
	// The key identifier, or name, of the tag.
	Key string `pulumi:"key"`
	// The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.
	Value string `pulumi:"value"`
}

A custom key-value pair associated with a resource within your organization.

type LookupAccountArgs

type LookupAccountArgs struct {
	// If the account was created successfully, the unique identifier (ID) of the new account.
	AccountId string `pulumi:"accountId"`
}

type LookupAccountOutputArgs

type LookupAccountOutputArgs struct {
	// If the account was created successfully, the unique identifier (ID) of the new account.
	AccountId pulumi.StringInput `pulumi:"accountId"`
}

func (LookupAccountOutputArgs) ElementType

func (LookupAccountOutputArgs) ElementType() reflect.Type

type LookupAccountResult

type LookupAccountResult struct {
	// If the account was created successfully, the unique identifier (ID) of the new account.
	AccountId *string `pulumi:"accountId"`
	// The friendly name of the member account.
	AccountName *string `pulumi:"accountName"`
	// The Amazon Resource Name (ARN) of the account.
	Arn *string `pulumi:"arn"`
	// The email address of the owner to assign to the new member account.
	Email *string `pulumi:"email"`
	// The method by which the account joined the organization.
	JoinedMethod *AccountJoinedMethod `pulumi:"joinedMethod"`
	// The date the account became a part of the organization.
	JoinedTimestamp *string `pulumi:"joinedTimestamp"`
	// List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.
	ParentIds []string `pulumi:"parentIds"`
	// The status of the account in the organization.
	Status *AccountStatus `pulumi:"status"`
	// A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value.
	Tags []aws.Tag `pulumi:"tags"`
}

func LookupAccount

func LookupAccount(ctx *pulumi.Context, args *LookupAccountArgs, opts ...pulumi.InvokeOption) (*LookupAccountResult, error)

You can use AWS::Organizations::Account to manage accounts in organization.

type LookupAccountResultOutput

type LookupAccountResultOutput struct{ *pulumi.OutputState }

func (LookupAccountResultOutput) AccountId

If the account was created successfully, the unique identifier (ID) of the new account.

func (LookupAccountResultOutput) AccountName

The friendly name of the member account.

func (LookupAccountResultOutput) Arn

The Amazon Resource Name (ARN) of the account.

func (LookupAccountResultOutput) ElementType

func (LookupAccountResultOutput) ElementType() reflect.Type

func (LookupAccountResultOutput) Email

The email address of the owner to assign to the new member account.

func (LookupAccountResultOutput) JoinedMethod

The method by which the account joined the organization.

func (LookupAccountResultOutput) JoinedTimestamp

func (o LookupAccountResultOutput) JoinedTimestamp() pulumi.StringPtrOutput

The date the account became a part of the organization.

func (LookupAccountResultOutput) ParentIds

List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.

func (LookupAccountResultOutput) Status

The status of the account in the organization.

func (LookupAccountResultOutput) Tags

A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value.

func (LookupAccountResultOutput) ToLookupAccountResultOutput

func (o LookupAccountResultOutput) ToLookupAccountResultOutput() LookupAccountResultOutput

func (LookupAccountResultOutput) ToLookupAccountResultOutputWithContext

func (o LookupAccountResultOutput) ToLookupAccountResultOutputWithContext(ctx context.Context) LookupAccountResultOutput

type LookupOrganizationArgs added in v0.67.0

type LookupOrganizationArgs struct {
	// The unique identifier (ID) of an organization.
	Id string `pulumi:"id"`
}

type LookupOrganizationOutputArgs added in v0.67.0

type LookupOrganizationOutputArgs struct {
	// The unique identifier (ID) of an organization.
	Id pulumi.StringInput `pulumi:"id"`
}

func (LookupOrganizationOutputArgs) ElementType added in v0.67.0

type LookupOrganizationResult added in v0.67.0

type LookupOrganizationResult struct {
	// The Amazon Resource Name (ARN) of an organization.
	Arn *string `pulumi:"arn"`
	// Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.
	FeatureSet *OrganizationFeatureSet `pulumi:"featureSet"`
	// The unique identifier (ID) of an organization.
	Id *string `pulumi:"id"`
	// The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization.
	ManagementAccountArn *string `pulumi:"managementAccountArn"`
	// The email address that is associated with the AWS account that is designated as the management account for the organization.
	ManagementAccountEmail *string `pulumi:"managementAccountEmail"`
	// The unique identifier (ID) of the management account of an organization.
	ManagementAccountId *string `pulumi:"managementAccountId"`
	// The unique identifier (ID) for the root.
	RootId *string `pulumi:"rootId"`
}

func LookupOrganization added in v0.67.0

func LookupOrganization(ctx *pulumi.Context, args *LookupOrganizationArgs, opts ...pulumi.InvokeOption) (*LookupOrganizationResult, error)

Resource schema for AWS::Organizations::Organization

type LookupOrganizationResultOutput added in v0.67.0

type LookupOrganizationResultOutput struct{ *pulumi.OutputState }

func LookupOrganizationOutput added in v0.67.0

func (LookupOrganizationResultOutput) Arn added in v0.67.0

The Amazon Resource Name (ARN) of an organization.

func (LookupOrganizationResultOutput) ElementType added in v0.67.0

func (LookupOrganizationResultOutput) FeatureSet added in v0.67.0

Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.

func (LookupOrganizationResultOutput) Id added in v0.67.0

The unique identifier (ID) of an organization.

func (LookupOrganizationResultOutput) ManagementAccountArn added in v0.67.0

func (o LookupOrganizationResultOutput) ManagementAccountArn() pulumi.StringPtrOutput

The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization.

func (LookupOrganizationResultOutput) ManagementAccountEmail added in v0.67.0

func (o LookupOrganizationResultOutput) ManagementAccountEmail() pulumi.StringPtrOutput

The email address that is associated with the AWS account that is designated as the management account for the organization.

func (LookupOrganizationResultOutput) ManagementAccountId added in v0.67.0

func (o LookupOrganizationResultOutput) ManagementAccountId() pulumi.StringPtrOutput

The unique identifier (ID) of the management account of an organization.

func (LookupOrganizationResultOutput) RootId added in v0.67.0

The unique identifier (ID) for the root.

func (LookupOrganizationResultOutput) ToLookupOrganizationResultOutput added in v0.67.0

func (o LookupOrganizationResultOutput) ToLookupOrganizationResultOutput() LookupOrganizationResultOutput

func (LookupOrganizationResultOutput) ToLookupOrganizationResultOutputWithContext added in v0.67.0

func (o LookupOrganizationResultOutput) ToLookupOrganizationResultOutputWithContext(ctx context.Context) LookupOrganizationResultOutput

type LookupOrganizationalUnitArgs

type LookupOrganizationalUnitArgs struct {
	// The unique identifier (ID) associated with this OU.
	Id string `pulumi:"id"`
}

type LookupOrganizationalUnitOutputArgs

type LookupOrganizationalUnitOutputArgs struct {
	// The unique identifier (ID) associated with this OU.
	Id pulumi.StringInput `pulumi:"id"`
}

func (LookupOrganizationalUnitOutputArgs) ElementType

type LookupOrganizationalUnitResult

type LookupOrganizationalUnitResult struct {
	// The Amazon Resource Name (ARN) of this OU.
	Arn *string `pulumi:"arn"`
	// The unique identifier (ID) associated with this OU.
	Id *string `pulumi:"id"`
	// The friendly name of this OU.
	Name *string `pulumi:"name"`
	// A list of tags that you want to attach to the newly created OU.
	Tags []aws.Tag `pulumi:"tags"`
}

func LookupOrganizationalUnit

func LookupOrganizationalUnit(ctx *pulumi.Context, args *LookupOrganizationalUnitArgs, opts ...pulumi.InvokeOption) (*LookupOrganizationalUnitResult, error)

You can use organizational units (OUs) to group accounts together to administer as a single unit. This greatly simplifies the management of your accounts. For example, you can attach a policy-based control to an OU, and all accounts within the OU automatically inherit the policy. You can create multiple OUs within a single organization, and you can create OUs within other OUs. Each OU can contain multiple accounts, and you can move accounts from one OU to another. However, OU names must be unique within a parent OU or root.

type LookupOrganizationalUnitResultOutput

type LookupOrganizationalUnitResultOutput struct{ *pulumi.OutputState }

func (LookupOrganizationalUnitResultOutput) Arn

The Amazon Resource Name (ARN) of this OU.

func (LookupOrganizationalUnitResultOutput) ElementType

func (LookupOrganizationalUnitResultOutput) Id

The unique identifier (ID) associated with this OU.

func (LookupOrganizationalUnitResultOutput) Name

The friendly name of this OU.

func (LookupOrganizationalUnitResultOutput) Tags

A list of tags that you want to attach to the newly created OU.

func (LookupOrganizationalUnitResultOutput) ToLookupOrganizationalUnitResultOutput

func (o LookupOrganizationalUnitResultOutput) ToLookupOrganizationalUnitResultOutput() LookupOrganizationalUnitResultOutput

func (LookupOrganizationalUnitResultOutput) ToLookupOrganizationalUnitResultOutputWithContext

func (o LookupOrganizationalUnitResultOutput) ToLookupOrganizationalUnitResultOutputWithContext(ctx context.Context) LookupOrganizationalUnitResultOutput

type LookupPolicyArgs

type LookupPolicyArgs struct {
	// Id of the Policy
	Id string `pulumi:"id"`
}

type LookupPolicyOutputArgs

type LookupPolicyOutputArgs struct {
	// Id of the Policy
	Id pulumi.StringInput `pulumi:"id"`
}

func (LookupPolicyOutputArgs) ElementType

func (LookupPolicyOutputArgs) ElementType() reflect.Type

type LookupPolicyResult

type LookupPolicyResult struct {
	// ARN of the Policy
	Arn *string `pulumi:"arn"`
	// A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
	AwsManaged *bool `pulumi:"awsManaged"`
	// The Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Organizations::Policy` for more information about the expected schema for this property.
	Content interface{} `pulumi:"content"`
	// Human readable description of the policy
	Description *string `pulumi:"description"`
	// Id of the Policy
	Id *string `pulumi:"id"`
	// Name of the Policy
	Name *string `pulumi:"name"`
	// A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null.
	Tags []aws.Tag `pulumi:"tags"`
	// List of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to
	TargetIds []string `pulumi:"targetIds"`
}

func LookupPolicy

func LookupPolicy(ctx *pulumi.Context, args *LookupPolicyArgs, opts ...pulumi.InvokeOption) (*LookupPolicyResult, error)

Policies in AWS Organizations enable you to manage different features of the AWS accounts in your organization. You can use policies when all features are enabled in your organization.

type LookupPolicyResultOutput

type LookupPolicyResultOutput struct{ *pulumi.OutputState }

func (LookupPolicyResultOutput) Arn

ARN of the Policy

func (LookupPolicyResultOutput) AwsManaged

A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.

func (LookupPolicyResultOutput) Content

The Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Organizations::Policy` for more information about the expected schema for this property.

func (LookupPolicyResultOutput) Description

Human readable description of the policy

func (LookupPolicyResultOutput) ElementType

func (LookupPolicyResultOutput) ElementType() reflect.Type

func (LookupPolicyResultOutput) Id

Id of the Policy

func (LookupPolicyResultOutput) Name

Name of the Policy

func (LookupPolicyResultOutput) Tags

A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null.

func (LookupPolicyResultOutput) TargetIds

List of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to

func (LookupPolicyResultOutput) ToLookupPolicyResultOutput

func (o LookupPolicyResultOutput) ToLookupPolicyResultOutput() LookupPolicyResultOutput

func (LookupPolicyResultOutput) ToLookupPolicyResultOutputWithContext

func (o LookupPolicyResultOutput) ToLookupPolicyResultOutputWithContext(ctx context.Context) LookupPolicyResultOutput

type LookupResourcePolicyArgs added in v0.51.0

type LookupResourcePolicyArgs struct {
	// The unique identifier (ID) associated with this resource policy.
	Id string `pulumi:"id"`
}

type LookupResourcePolicyOutputArgs added in v0.51.0

type LookupResourcePolicyOutputArgs struct {
	// The unique identifier (ID) associated with this resource policy.
	Id pulumi.StringInput `pulumi:"id"`
}

func (LookupResourcePolicyOutputArgs) ElementType added in v0.51.0

type LookupResourcePolicyResult added in v0.51.0

type LookupResourcePolicyResult struct {
	// The Amazon Resource Name (ARN) of the resource policy.
	Arn *string `pulumi:"arn"`
	// The policy document. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Organizations::ResourcePolicy` for more information about the expected schema for this property.
	Content interface{} `pulumi:"content"`
	// The unique identifier (ID) associated with this resource policy.
	Id *string `pulumi:"id"`
	// A list of tags that you want to attach to the resource policy
	Tags []aws.Tag `pulumi:"tags"`
}

func LookupResourcePolicy added in v0.51.0

func LookupResourcePolicy(ctx *pulumi.Context, args *LookupResourcePolicyArgs, opts ...pulumi.InvokeOption) (*LookupResourcePolicyResult, error)

You can use AWS::Organizations::ResourcePolicy to delegate policy management for AWS Organizations to specified member accounts to perform policy actions that are by default available only to the management account.

type LookupResourcePolicyResultOutput added in v0.51.0

type LookupResourcePolicyResultOutput struct{ *pulumi.OutputState }

func LookupResourcePolicyOutput added in v0.51.0

func (LookupResourcePolicyResultOutput) Arn added in v0.51.0

The Amazon Resource Name (ARN) of the resource policy.

func (LookupResourcePolicyResultOutput) Content added in v0.51.0

The policy document. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Organizations::ResourcePolicy` for more information about the expected schema for this property.

func (LookupResourcePolicyResultOutput) ElementType added in v0.51.0

func (LookupResourcePolicyResultOutput) Id added in v0.51.0

The unique identifier (ID) associated with this resource policy.

func (LookupResourcePolicyResultOutput) Tags added in v0.51.0

A list of tags that you want to attach to the resource policy

func (LookupResourcePolicyResultOutput) ToLookupResourcePolicyResultOutput added in v0.51.0

func (o LookupResourcePolicyResultOutput) ToLookupResourcePolicyResultOutput() LookupResourcePolicyResultOutput

func (LookupResourcePolicyResultOutput) ToLookupResourcePolicyResultOutputWithContext added in v0.51.0

func (o LookupResourcePolicyResultOutput) ToLookupResourcePolicyResultOutputWithContext(ctx context.Context) LookupResourcePolicyResultOutput

type Organization added in v0.67.0

type Organization struct {
	pulumi.CustomResourceState

	// The Amazon Resource Name (ARN) of an organization.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The unique identifier (ID) of an organization.
	AwsId pulumi.StringOutput `pulumi:"awsId"`
	// Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.
	FeatureSet OrganizationFeatureSetPtrOutput `pulumi:"featureSet"`
	// The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization.
	ManagementAccountArn pulumi.StringOutput `pulumi:"managementAccountArn"`
	// The email address that is associated with the AWS account that is designated as the management account for the organization.
	ManagementAccountEmail pulumi.StringOutput `pulumi:"managementAccountEmail"`
	// The unique identifier (ID) of the management account of an organization.
	ManagementAccountId pulumi.StringOutput `pulumi:"managementAccountId"`
	// The unique identifier (ID) for the root.
	RootId pulumi.StringOutput `pulumi:"rootId"`
}

Resource schema for AWS::Organizations::Organization

func GetOrganization added in v0.67.0

func GetOrganization(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *OrganizationState, opts ...pulumi.ResourceOption) (*Organization, error)

GetOrganization gets an existing Organization 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 NewOrganization added in v0.67.0

func NewOrganization(ctx *pulumi.Context,
	name string, args *OrganizationArgs, opts ...pulumi.ResourceOption) (*Organization, error)

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

func (*Organization) ElementType added in v0.67.0

func (*Organization) ElementType() reflect.Type

func (*Organization) ToOrganizationOutput added in v0.67.0

func (i *Organization) ToOrganizationOutput() OrganizationOutput

func (*Organization) ToOrganizationOutputWithContext added in v0.67.0

func (i *Organization) ToOrganizationOutputWithContext(ctx context.Context) OrganizationOutput

type OrganizationArgs added in v0.67.0

type OrganizationArgs struct {
	// Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.
	FeatureSet OrganizationFeatureSetPtrInput
}

The set of arguments for constructing a Organization resource.

func (OrganizationArgs) ElementType added in v0.67.0

func (OrganizationArgs) ElementType() reflect.Type

type OrganizationFeatureSet added in v0.67.0

type OrganizationFeatureSet string

Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.

func (OrganizationFeatureSet) ElementType added in v0.67.0

func (OrganizationFeatureSet) ElementType() reflect.Type

func (OrganizationFeatureSet) ToOrganizationFeatureSetOutput added in v0.67.0

func (e OrganizationFeatureSet) ToOrganizationFeatureSetOutput() OrganizationFeatureSetOutput

func (OrganizationFeatureSet) ToOrganizationFeatureSetOutputWithContext added in v0.67.0

func (e OrganizationFeatureSet) ToOrganizationFeatureSetOutputWithContext(ctx context.Context) OrganizationFeatureSetOutput

func (OrganizationFeatureSet) ToOrganizationFeatureSetPtrOutput added in v0.67.0

func (e OrganizationFeatureSet) ToOrganizationFeatureSetPtrOutput() OrganizationFeatureSetPtrOutput

func (OrganizationFeatureSet) ToOrganizationFeatureSetPtrOutputWithContext added in v0.67.0

func (e OrganizationFeatureSet) ToOrganizationFeatureSetPtrOutputWithContext(ctx context.Context) OrganizationFeatureSetPtrOutput

func (OrganizationFeatureSet) ToStringOutput added in v0.67.0

func (e OrganizationFeatureSet) ToStringOutput() pulumi.StringOutput

func (OrganizationFeatureSet) ToStringOutputWithContext added in v0.67.0

func (e OrganizationFeatureSet) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (OrganizationFeatureSet) ToStringPtrOutput added in v0.67.0

func (e OrganizationFeatureSet) ToStringPtrOutput() pulumi.StringPtrOutput

func (OrganizationFeatureSet) ToStringPtrOutputWithContext added in v0.67.0

func (e OrganizationFeatureSet) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type OrganizationFeatureSetInput added in v0.67.0

type OrganizationFeatureSetInput interface {
	pulumi.Input

	ToOrganizationFeatureSetOutput() OrganizationFeatureSetOutput
	ToOrganizationFeatureSetOutputWithContext(context.Context) OrganizationFeatureSetOutput
}

OrganizationFeatureSetInput is an input type that accepts values of the OrganizationFeatureSet enum A concrete instance of `OrganizationFeatureSetInput` can be one of the following:

OrganizationFeatureSetAll
OrganizationFeatureSetConsolidatedBilling

type OrganizationFeatureSetOutput added in v0.67.0

type OrganizationFeatureSetOutput struct{ *pulumi.OutputState }

func (OrganizationFeatureSetOutput) ElementType added in v0.67.0

func (OrganizationFeatureSetOutput) ToOrganizationFeatureSetOutput added in v0.67.0

func (o OrganizationFeatureSetOutput) ToOrganizationFeatureSetOutput() OrganizationFeatureSetOutput

func (OrganizationFeatureSetOutput) ToOrganizationFeatureSetOutputWithContext added in v0.67.0

func (o OrganizationFeatureSetOutput) ToOrganizationFeatureSetOutputWithContext(ctx context.Context) OrganizationFeatureSetOutput

func (OrganizationFeatureSetOutput) ToOrganizationFeatureSetPtrOutput added in v0.67.0

func (o OrganizationFeatureSetOutput) ToOrganizationFeatureSetPtrOutput() OrganizationFeatureSetPtrOutput

func (OrganizationFeatureSetOutput) ToOrganizationFeatureSetPtrOutputWithContext added in v0.67.0

func (o OrganizationFeatureSetOutput) ToOrganizationFeatureSetPtrOutputWithContext(ctx context.Context) OrganizationFeatureSetPtrOutput

func (OrganizationFeatureSetOutput) ToStringOutput added in v0.67.0

func (OrganizationFeatureSetOutput) ToStringOutputWithContext added in v0.67.0

func (o OrganizationFeatureSetOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (OrganizationFeatureSetOutput) ToStringPtrOutput added in v0.67.0

func (o OrganizationFeatureSetOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (OrganizationFeatureSetOutput) ToStringPtrOutputWithContext added in v0.67.0

func (o OrganizationFeatureSetOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type OrganizationFeatureSetPtrInput added in v0.67.0

type OrganizationFeatureSetPtrInput interface {
	pulumi.Input

	ToOrganizationFeatureSetPtrOutput() OrganizationFeatureSetPtrOutput
	ToOrganizationFeatureSetPtrOutputWithContext(context.Context) OrganizationFeatureSetPtrOutput
}

func OrganizationFeatureSetPtr added in v0.67.0

func OrganizationFeatureSetPtr(v string) OrganizationFeatureSetPtrInput

type OrganizationFeatureSetPtrOutput added in v0.67.0

type OrganizationFeatureSetPtrOutput struct{ *pulumi.OutputState }

func (OrganizationFeatureSetPtrOutput) Elem added in v0.67.0

func (OrganizationFeatureSetPtrOutput) ElementType added in v0.67.0

func (OrganizationFeatureSetPtrOutput) ToOrganizationFeatureSetPtrOutput added in v0.67.0

func (o OrganizationFeatureSetPtrOutput) ToOrganizationFeatureSetPtrOutput() OrganizationFeatureSetPtrOutput

func (OrganizationFeatureSetPtrOutput) ToOrganizationFeatureSetPtrOutputWithContext added in v0.67.0

func (o OrganizationFeatureSetPtrOutput) ToOrganizationFeatureSetPtrOutputWithContext(ctx context.Context) OrganizationFeatureSetPtrOutput

func (OrganizationFeatureSetPtrOutput) ToStringPtrOutput added in v0.67.0

func (OrganizationFeatureSetPtrOutput) ToStringPtrOutputWithContext added in v0.67.0

func (o OrganizationFeatureSetPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type OrganizationInput added in v0.67.0

type OrganizationInput interface {
	pulumi.Input

	ToOrganizationOutput() OrganizationOutput
	ToOrganizationOutputWithContext(ctx context.Context) OrganizationOutput
}

type OrganizationOutput added in v0.67.0

type OrganizationOutput struct{ *pulumi.OutputState }

func (OrganizationOutput) Arn added in v0.67.0

The Amazon Resource Name (ARN) of an organization.

func (OrganizationOutput) AwsId added in v0.99.0

The unique identifier (ID) of an organization.

func (OrganizationOutput) ElementType added in v0.67.0

func (OrganizationOutput) ElementType() reflect.Type

func (OrganizationOutput) FeatureSet added in v0.67.0

Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.

func (OrganizationOutput) ManagementAccountArn added in v0.67.0

func (o OrganizationOutput) ManagementAccountArn() pulumi.StringOutput

The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization.

func (OrganizationOutput) ManagementAccountEmail added in v0.67.0

func (o OrganizationOutput) ManagementAccountEmail() pulumi.StringOutput

The email address that is associated with the AWS account that is designated as the management account for the organization.

func (OrganizationOutput) ManagementAccountId added in v0.67.0

func (o OrganizationOutput) ManagementAccountId() pulumi.StringOutput

The unique identifier (ID) of the management account of an organization.

func (OrganizationOutput) RootId added in v0.67.0

The unique identifier (ID) for the root.

func (OrganizationOutput) ToOrganizationOutput added in v0.67.0

func (o OrganizationOutput) ToOrganizationOutput() OrganizationOutput

func (OrganizationOutput) ToOrganizationOutputWithContext added in v0.67.0

func (o OrganizationOutput) ToOrganizationOutputWithContext(ctx context.Context) OrganizationOutput

type OrganizationState added in v0.67.0

type OrganizationState struct {
}

func (OrganizationState) ElementType added in v0.67.0

func (OrganizationState) ElementType() reflect.Type

type OrganizationalUnit

type OrganizationalUnit struct {
	pulumi.CustomResourceState

	// The Amazon Resource Name (ARN) of this OU.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The unique identifier (ID) associated with this OU.
	AwsId pulumi.StringOutput `pulumi:"awsId"`
	// The friendly name of this OU.
	Name pulumi.StringOutput `pulumi:"name"`
	// The unique identifier (ID) of the parent root or OU that you want to create the new OU in.
	ParentId pulumi.StringOutput `pulumi:"parentId"`
	// A list of tags that you want to attach to the newly created OU.
	Tags aws.TagArrayOutput `pulumi:"tags"`
}

You can use organizational units (OUs) to group accounts together to administer as a single unit. This greatly simplifies the management of your accounts. For example, you can attach a policy-based control to an OU, and all accounts within the OU automatically inherit the policy. You can create multiple OUs within a single organization, and you can create OUs within other OUs. Each OU can contain multiple accounts, and you can move accounts from one OU to another. However, OU names must be unique within a parent OU or root.

## Example Usage ### Example

```go package main

import (

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/organizations"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		organizationRootId := cfg.Require("organizationRootId")
		_, err := organizations.NewOrganizationalUnit(ctx, "testTemplateOU", &organizations.OrganizationalUnitArgs{
			Name:     pulumi.String("TestTemplateOU"),
			ParentId: pulumi.String(organizationRootId),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Example

```go package main

import (

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/organizations"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		organizationRootId := cfg.Require("organizationRootId")
		_, err := organizations.NewOrganizationalUnit(ctx, "testTemplateOU", &organizations.OrganizationalUnitArgs{
			Name:     pulumi.String("TestTemplateOU"),
			ParentId: pulumi.String(organizationRootId),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Example

```go package main

import (

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/organizations"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		organizationRootId := cfg.Require("organizationRootId")
		parentOU, err := organizations.NewOrganizationalUnit(ctx, "parentOU", &organizations.OrganizationalUnitArgs{
			Name:     pulumi.String("ParentOU"),
			ParentId: pulumi.String(organizationRootId),
		})
		if err != nil {
			return err
		}
		_, err = organizations.NewOrganizationalUnit(ctx, "childOU", &organizations.OrganizationalUnitArgs{
			Name:     pulumi.String("ChildOU"),
			ParentId: parentOU.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Example

```go package main

import (

"github.com/pulumi/pulumi-aws-native/sdk/go/aws/organizations"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		organizationRootId := cfg.Require("organizationRootId")
		parentOU, err := organizations.NewOrganizationalUnit(ctx, "parentOU", &organizations.OrganizationalUnitArgs{
			Name:     pulumi.String("ParentOU"),
			ParentId: pulumi.String(organizationRootId),
		})
		if err != nil {
			return err
		}
		_, err = organizations.NewOrganizationalUnit(ctx, "childOU", &organizations.OrganizationalUnitArgs{
			Name:     pulumi.String("ChildOU"),
			ParentId: parentOU.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetOrganizationalUnit

func GetOrganizationalUnit(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *OrganizationalUnitState, opts ...pulumi.ResourceOption) (*OrganizationalUnit, error)

GetOrganizationalUnit gets an existing OrganizationalUnit 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 NewOrganizationalUnit

func NewOrganizationalUnit(ctx *pulumi.Context,
	name string, args *OrganizationalUnitArgs, opts ...pulumi.ResourceOption) (*OrganizationalUnit, error)

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

func (*OrganizationalUnit) ElementType

func (*OrganizationalUnit) ElementType() reflect.Type

func (*OrganizationalUnit) ToOrganizationalUnitOutput

func (i *OrganizationalUnit) ToOrganizationalUnitOutput() OrganizationalUnitOutput

func (*OrganizationalUnit) ToOrganizationalUnitOutputWithContext

func (i *OrganizationalUnit) ToOrganizationalUnitOutputWithContext(ctx context.Context) OrganizationalUnitOutput

type OrganizationalUnitArgs

type OrganizationalUnitArgs struct {
	// The friendly name of this OU.
	Name pulumi.StringPtrInput
	// The unique identifier (ID) of the parent root or OU that you want to create the new OU in.
	ParentId pulumi.StringInput
	// A list of tags that you want to attach to the newly created OU.
	Tags aws.TagArrayInput
}

The set of arguments for constructing a OrganizationalUnit resource.

func (OrganizationalUnitArgs) ElementType

func (OrganizationalUnitArgs) ElementType() reflect.Type

type OrganizationalUnitInput

type OrganizationalUnitInput interface {
	pulumi.Input

	ToOrganizationalUnitOutput() OrganizationalUnitOutput
	ToOrganizationalUnitOutputWithContext(ctx context.Context) OrganizationalUnitOutput
}

type OrganizationalUnitOutput

type OrganizationalUnitOutput struct{ *pulumi.OutputState }

func (OrganizationalUnitOutput) Arn

The Amazon Resource Name (ARN) of this OU.

func (OrganizationalUnitOutput) AwsId added in v0.99.0

The unique identifier (ID) associated with this OU.

func (OrganizationalUnitOutput) ElementType

func (OrganizationalUnitOutput) ElementType() reflect.Type

func (OrganizationalUnitOutput) Name

The friendly name of this OU.

func (OrganizationalUnitOutput) ParentId

The unique identifier (ID) of the parent root or OU that you want to create the new OU in.

func (OrganizationalUnitOutput) Tags

A list of tags that you want to attach to the newly created OU.

func (OrganizationalUnitOutput) ToOrganizationalUnitOutput

func (o OrganizationalUnitOutput) ToOrganizationalUnitOutput() OrganizationalUnitOutput

func (OrganizationalUnitOutput) ToOrganizationalUnitOutputWithContext

func (o OrganizationalUnitOutput) ToOrganizationalUnitOutputWithContext(ctx context.Context) OrganizationalUnitOutput

type OrganizationalUnitState

type OrganizationalUnitState struct {
}

func (OrganizationalUnitState) ElementType

func (OrganizationalUnitState) ElementType() reflect.Type

type OrganizationalUnitTag

type OrganizationalUnitTag struct {
	// The key identifier, or name, of the tag.
	Key string `pulumi:"key"`
	// The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.
	Value string `pulumi:"value"`
}

A custom key-value pair associated with a resource within your organization.

type Policy

type Policy struct {
	pulumi.CustomResourceState

	// ARN of the Policy
	Arn pulumi.StringOutput `pulumi:"arn"`
	// Id of the Policy
	AwsId pulumi.StringOutput `pulumi:"awsId"`
	// A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.
	AwsManaged pulumi.BoolOutput `pulumi:"awsManaged"`
	// The Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Organizations::Policy` for more information about the expected schema for this property.
	Content pulumi.AnyOutput `pulumi:"content"`
	// Human readable description of the policy
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Name of the Policy
	Name pulumi.StringOutput `pulumi:"name"`
	// A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null.
	Tags aws.TagArrayOutput `pulumi:"tags"`
	// List of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to
	TargetIds pulumi.StringArrayOutput `pulumi:"targetIds"`
	// The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY
	Type PolicyTypeOutput `pulumi:"type"`
}

Policies in AWS Organizations enable you to manage different features of the AWS accounts in your organization. You can use policies when all features are enabled in your organization.

func GetPolicy

func GetPolicy(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *PolicyState, opts ...pulumi.ResourceOption) (*Policy, error)

GetPolicy gets an existing Policy 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 NewPolicy

func NewPolicy(ctx *pulumi.Context,
	name string, args *PolicyArgs, opts ...pulumi.ResourceOption) (*Policy, error)

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

func (*Policy) ElementType

func (*Policy) ElementType() reflect.Type

func (*Policy) ToPolicyOutput

func (i *Policy) ToPolicyOutput() PolicyOutput

func (*Policy) ToPolicyOutputWithContext

func (i *Policy) ToPolicyOutputWithContext(ctx context.Context) PolicyOutput

type PolicyArgs

type PolicyArgs struct {
	// The Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Organizations::Policy` for more information about the expected schema for this property.
	Content pulumi.Input
	// Human readable description of the policy
	Description pulumi.StringPtrInput
	// Name of the Policy
	Name pulumi.StringPtrInput
	// A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null.
	Tags aws.TagArrayInput
	// List of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to
	TargetIds pulumi.StringArrayInput
	// The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY
	Type PolicyTypeInput
}

The set of arguments for constructing a Policy resource.

func (PolicyArgs) ElementType

func (PolicyArgs) ElementType() reflect.Type

type PolicyInput

type PolicyInput interface {
	pulumi.Input

	ToPolicyOutput() PolicyOutput
	ToPolicyOutputWithContext(ctx context.Context) PolicyOutput
}

type PolicyOutput

type PolicyOutput struct{ *pulumi.OutputState }

func (PolicyOutput) Arn

ARN of the Policy

func (PolicyOutput) AwsId added in v0.99.0

func (o PolicyOutput) AwsId() pulumi.StringOutput

Id of the Policy

func (PolicyOutput) AwsManaged

func (o PolicyOutput) AwsManaged() pulumi.BoolOutput

A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.

func (PolicyOutput) Content

func (o PolicyOutput) Content() pulumi.AnyOutput

The Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Organizations::Policy` for more information about the expected schema for this property.

func (PolicyOutput) Description

func (o PolicyOutput) Description() pulumi.StringPtrOutput

Human readable description of the policy

func (PolicyOutput) ElementType

func (PolicyOutput) ElementType() reflect.Type

func (PolicyOutput) Name

func (o PolicyOutput) Name() pulumi.StringOutput

Name of the Policy

func (PolicyOutput) Tags

func (o PolicyOutput) Tags() aws.TagArrayOutput

A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null.

func (PolicyOutput) TargetIds

func (o PolicyOutput) TargetIds() pulumi.StringArrayOutput

List of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to

func (PolicyOutput) ToPolicyOutput

func (o PolicyOutput) ToPolicyOutput() PolicyOutput

func (PolicyOutput) ToPolicyOutputWithContext

func (o PolicyOutput) ToPolicyOutputWithContext(ctx context.Context) PolicyOutput

func (PolicyOutput) Type

func (o PolicyOutput) Type() PolicyTypeOutput

The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY

type PolicyState

type PolicyState struct {
}

func (PolicyState) ElementType

func (PolicyState) ElementType() reflect.Type

type PolicyTag

type PolicyTag struct {
	// The key identifier, or name, of the tag.
	Key string `pulumi:"key"`
	// The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.
	Value string `pulumi:"value"`
}

A custom key-value pair associated with a resource within your organization.

type PolicyType

type PolicyType string

The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY

func (PolicyType) ElementType

func (PolicyType) ElementType() reflect.Type

func (PolicyType) ToPolicyTypeOutput

func (e PolicyType) ToPolicyTypeOutput() PolicyTypeOutput

func (PolicyType) ToPolicyTypeOutputWithContext

func (e PolicyType) ToPolicyTypeOutputWithContext(ctx context.Context) PolicyTypeOutput

func (PolicyType) ToPolicyTypePtrOutput

func (e PolicyType) ToPolicyTypePtrOutput() PolicyTypePtrOutput

func (PolicyType) ToPolicyTypePtrOutputWithContext

func (e PolicyType) ToPolicyTypePtrOutputWithContext(ctx context.Context) PolicyTypePtrOutput

func (PolicyType) ToStringOutput

func (e PolicyType) ToStringOutput() pulumi.StringOutput

func (PolicyType) ToStringOutputWithContext

func (e PolicyType) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (PolicyType) ToStringPtrOutput

func (e PolicyType) ToStringPtrOutput() pulumi.StringPtrOutput

func (PolicyType) ToStringPtrOutputWithContext

func (e PolicyType) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type PolicyTypeInput

type PolicyTypeInput interface {
	pulumi.Input

	ToPolicyTypeOutput() PolicyTypeOutput
	ToPolicyTypeOutputWithContext(context.Context) PolicyTypeOutput
}

PolicyTypeInput is an input type that accepts values of the PolicyType enum A concrete instance of `PolicyTypeInput` can be one of the following:

PolicyTypeServiceControlPolicy
PolicyTypeAiservicesOptOutPolicy
PolicyTypeBackupPolicy
PolicyTypeTagPolicy

type PolicyTypeOutput

type PolicyTypeOutput struct{ *pulumi.OutputState }

func (PolicyTypeOutput) ElementType

func (PolicyTypeOutput) ElementType() reflect.Type

func (PolicyTypeOutput) ToPolicyTypeOutput

func (o PolicyTypeOutput) ToPolicyTypeOutput() PolicyTypeOutput

func (PolicyTypeOutput) ToPolicyTypeOutputWithContext

func (o PolicyTypeOutput) ToPolicyTypeOutputWithContext(ctx context.Context) PolicyTypeOutput

func (PolicyTypeOutput) ToPolicyTypePtrOutput

func (o PolicyTypeOutput) ToPolicyTypePtrOutput() PolicyTypePtrOutput

func (PolicyTypeOutput) ToPolicyTypePtrOutputWithContext

func (o PolicyTypeOutput) ToPolicyTypePtrOutputWithContext(ctx context.Context) PolicyTypePtrOutput

func (PolicyTypeOutput) ToStringOutput

func (o PolicyTypeOutput) ToStringOutput() pulumi.StringOutput

func (PolicyTypeOutput) ToStringOutputWithContext

func (o PolicyTypeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (PolicyTypeOutput) ToStringPtrOutput

func (o PolicyTypeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (PolicyTypeOutput) ToStringPtrOutputWithContext

func (o PolicyTypeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type PolicyTypePtrInput

type PolicyTypePtrInput interface {
	pulumi.Input

	ToPolicyTypePtrOutput() PolicyTypePtrOutput
	ToPolicyTypePtrOutputWithContext(context.Context) PolicyTypePtrOutput
}

func PolicyTypePtr

func PolicyTypePtr(v string) PolicyTypePtrInput

type PolicyTypePtrOutput

type PolicyTypePtrOutput struct{ *pulumi.OutputState }

func (PolicyTypePtrOutput) Elem

func (PolicyTypePtrOutput) ElementType

func (PolicyTypePtrOutput) ElementType() reflect.Type

func (PolicyTypePtrOutput) ToPolicyTypePtrOutput

func (o PolicyTypePtrOutput) ToPolicyTypePtrOutput() PolicyTypePtrOutput

func (PolicyTypePtrOutput) ToPolicyTypePtrOutputWithContext

func (o PolicyTypePtrOutput) ToPolicyTypePtrOutputWithContext(ctx context.Context) PolicyTypePtrOutput

func (PolicyTypePtrOutput) ToStringPtrOutput

func (o PolicyTypePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (PolicyTypePtrOutput) ToStringPtrOutputWithContext

func (o PolicyTypePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type ResourcePolicy added in v0.51.0

type ResourcePolicy struct {
	pulumi.CustomResourceState

	// The Amazon Resource Name (ARN) of the resource policy.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The unique identifier (ID) associated with this resource policy.
	AwsId pulumi.StringOutput `pulumi:"awsId"`
	// The policy document. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Organizations::ResourcePolicy` for more information about the expected schema for this property.
	Content pulumi.AnyOutput `pulumi:"content"`
	// A list of tags that you want to attach to the resource policy
	Tags aws.TagArrayOutput `pulumi:"tags"`
}

You can use AWS::Organizations::ResourcePolicy to delegate policy management for AWS Organizations to specified member accounts to perform policy actions that are by default available only to the management account.

func GetResourcePolicy added in v0.51.0

func GetResourcePolicy(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ResourcePolicyState, opts ...pulumi.ResourceOption) (*ResourcePolicy, error)

GetResourcePolicy gets an existing ResourcePolicy 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 NewResourcePolicy added in v0.51.0

func NewResourcePolicy(ctx *pulumi.Context,
	name string, args *ResourcePolicyArgs, opts ...pulumi.ResourceOption) (*ResourcePolicy, error)

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

func (*ResourcePolicy) ElementType added in v0.51.0

func (*ResourcePolicy) ElementType() reflect.Type

func (*ResourcePolicy) ToResourcePolicyOutput added in v0.51.0

func (i *ResourcePolicy) ToResourcePolicyOutput() ResourcePolicyOutput

func (*ResourcePolicy) ToResourcePolicyOutputWithContext added in v0.51.0

func (i *ResourcePolicy) ToResourcePolicyOutputWithContext(ctx context.Context) ResourcePolicyOutput

type ResourcePolicyArgs added in v0.51.0

type ResourcePolicyArgs struct {
	// The policy document. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.
	//
	// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Organizations::ResourcePolicy` for more information about the expected schema for this property.
	Content pulumi.Input
	// A list of tags that you want to attach to the resource policy
	Tags aws.TagArrayInput
}

The set of arguments for constructing a ResourcePolicy resource.

func (ResourcePolicyArgs) ElementType added in v0.51.0

func (ResourcePolicyArgs) ElementType() reflect.Type

type ResourcePolicyInput added in v0.51.0

type ResourcePolicyInput interface {
	pulumi.Input

	ToResourcePolicyOutput() ResourcePolicyOutput
	ToResourcePolicyOutputWithContext(ctx context.Context) ResourcePolicyOutput
}

type ResourcePolicyOutput added in v0.51.0

type ResourcePolicyOutput struct{ *pulumi.OutputState }

func (ResourcePolicyOutput) Arn added in v0.51.0

The Amazon Resource Name (ARN) of the resource policy.

func (ResourcePolicyOutput) AwsId added in v0.99.0

The unique identifier (ID) associated with this resource policy.

func (ResourcePolicyOutput) Content added in v0.51.0

The policy document. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.

Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Organizations::ResourcePolicy` for more information about the expected schema for this property.

func (ResourcePolicyOutput) ElementType added in v0.51.0

func (ResourcePolicyOutput) ElementType() reflect.Type

func (ResourcePolicyOutput) Tags added in v0.51.0

A list of tags that you want to attach to the resource policy

func (ResourcePolicyOutput) ToResourcePolicyOutput added in v0.51.0

func (o ResourcePolicyOutput) ToResourcePolicyOutput() ResourcePolicyOutput

func (ResourcePolicyOutput) ToResourcePolicyOutputWithContext added in v0.51.0

func (o ResourcePolicyOutput) ToResourcePolicyOutputWithContext(ctx context.Context) ResourcePolicyOutput

type ResourcePolicyState added in v0.51.0

type ResourcePolicyState struct {
}

func (ResourcePolicyState) ElementType added in v0.51.0

func (ResourcePolicyState) ElementType() reflect.Type

type ResourcePolicyTag added in v0.51.0

type ResourcePolicyTag struct {
	// The key identifier, or name, of the tag.
	Key string `pulumi:"key"`
	// The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.
	Value string `pulumi:"value"`
}

A custom key-value pair associated with a resource within your organization.

Jump to

Keyboard shortcuts

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