Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. organizations
  5. DelegatedAdministrator
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.organizations.DelegatedAdministrator

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a resource to manage an AWS Organizations Delegated Administrator.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.organizations.DelegatedAdministrator("example", {
    accountId: "123456789012",
    servicePrincipal: "principal",
});

    import pulumi
import pulumi_aws as aws

example = aws.organizations.DelegatedAdministrator("example",
    account_id="123456789012",
    service_principal="principal")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/organizations"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := organizations.NewDelegatedAdministrator(ctx, "example", &organizations.DelegatedAdministratorArgs{
			AccountId:        pulumi.String("123456789012"),
			ServicePrincipal: pulumi.String("principal"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Organizations.DelegatedAdministrator("example", new()
    {
        AccountId = "123456789012",
        ServicePrincipal = "principal",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.organizations.DelegatedAdministrator;
import com.pulumi.aws.organizations.DelegatedAdministratorArgs;
import java.util.List;
import java.util.ArrayList;
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 DelegatedAdministrator("example", DelegatedAdministratorArgs.builder()
            .accountId("123456789012")
            .servicePrincipal("principal")
            .build());

    }
}

    resources:
  example:
    type: aws:organizations:DelegatedAdministrator
    properties:
      accountId: '123456789012'
      servicePrincipal: principal

    Create DelegatedAdministrator Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DelegatedAdministrator(name: string, args: DelegatedAdministratorArgs, opts?: CustomResourceOptions);
    @overload
def DelegatedAdministrator(resource_name: str,
                           args: DelegatedAdministratorArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def DelegatedAdministrator(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           account_id: Optional[str] = None,
                           service_principal: Optional[str] = None)
    func NewDelegatedAdministrator(ctx *Context, name string, args DelegatedAdministratorArgs, opts ...ResourceOption) (*DelegatedAdministrator, error)
    public DelegatedAdministrator(string name, DelegatedAdministratorArgs args, CustomResourceOptions? opts = null)
    public DelegatedAdministrator(String name, DelegatedAdministratorArgs args)
public DelegatedAdministrator(String name, DelegatedAdministratorArgs args, CustomResourceOptions options)

    type: aws:organizations:DelegatedAdministrator
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DelegatedAdministratorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DelegatedAdministratorArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DelegatedAdministratorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DelegatedAdministratorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DelegatedAdministratorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var delegatedAdministratorResource = new Aws.Organizations.DelegatedAdministrator("delegatedAdministratorResource", new()
{
    AccountId = "string",
    ServicePrincipal = "string",
});

    example, err := organizations.NewDelegatedAdministrator(ctx, "delegatedAdministratorResource", &organizations.DelegatedAdministratorArgs{
	AccountId:        pulumi.String("string"),
	ServicePrincipal: pulumi.String("string"),
})

    var delegatedAdministratorResource = new DelegatedAdministrator("delegatedAdministratorResource", DelegatedAdministratorArgs.builder()
    .accountId("string")
    .servicePrincipal("string")
    .build());

    delegated_administrator_resource = aws.organizations.DelegatedAdministrator("delegatedAdministratorResource",
    account_id="string",
    service_principal="string")

    const delegatedAdministratorResource = new aws.organizations.DelegatedAdministrator("delegatedAdministratorResource", {
    accountId: "string",
    servicePrincipal: "string",
});

    type: aws:organizations:DelegatedAdministrator
properties:
    accountId: string
    servicePrincipal: string

    DelegatedAdministrator Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DelegatedAdministrator resource accepts the following input properties:

    AccountId string
    The account ID number of the member account in the organization to register as a delegated administrator.
    ServicePrincipal string
    The service principal of the AWS service for which you want to make the member account a delegated administrator.
    AccountId string
    The account ID number of the member account in the organization to register as a delegated administrator.
    ServicePrincipal string
    The service principal of the AWS service for which you want to make the member account a delegated administrator.
    accountId String
    The account ID number of the member account in the organization to register as a delegated administrator.
    servicePrincipal String
    The service principal of the AWS service for which you want to make the member account a delegated administrator.
    accountId string
    The account ID number of the member account in the organization to register as a delegated administrator.
    servicePrincipal string
    The service principal of the AWS service for which you want to make the member account a delegated administrator.
    account_id str
    The account ID number of the member account in the organization to register as a delegated administrator.
    service_principal str
    The service principal of the AWS service for which you want to make the member account a delegated administrator.
    accountId String
    The account ID number of the member account in the organization to register as a delegated administrator.
    servicePrincipal String
    The service principal of the AWS service for which you want to make the member account a delegated administrator.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DelegatedAdministrator resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the delegated administrator's account.
    DelegationEnabledDate string
    The date when the account was made a delegated administrator.
    Email string
    The email address that is associated with the delegated administrator's AWS account.
    Id string
    The provider-assigned unique ID for this managed resource.
    JoinedMethod string
    The method by which the delegated administrator's account joined the organization.
    JoinedTimestamp string
    The date when the delegated administrator's account became a part of the organization.
    Name string
    The friendly name of the delegated administrator's account.
    Status string
    The status of the delegated administrator's account in the organization.
    Arn string
    The Amazon Resource Name (ARN) of the delegated administrator's account.
    DelegationEnabledDate string
    The date when the account was made a delegated administrator.
    Email string
    The email address that is associated with the delegated administrator's AWS account.
    Id string
    The provider-assigned unique ID for this managed resource.
    JoinedMethod string
    The method by which the delegated administrator's account joined the organization.
    JoinedTimestamp string
    The date when the delegated administrator's account became a part of the organization.
    Name string
    The friendly name of the delegated administrator's account.
    Status string
    The status of the delegated administrator's account in the organization.
    arn String
    The Amazon Resource Name (ARN) of the delegated administrator's account.
    delegationEnabledDate String
    The date when the account was made a delegated administrator.
    email String
    The email address that is associated with the delegated administrator's AWS account.
    id String
    The provider-assigned unique ID for this managed resource.
    joinedMethod String
    The method by which the delegated administrator's account joined the organization.
    joinedTimestamp String
    The date when the delegated administrator's account became a part of the organization.
    name String
    The friendly name of the delegated administrator's account.
    status String
    The status of the delegated administrator's account in the organization.
    arn string
    The Amazon Resource Name (ARN) of the delegated administrator's account.
    delegationEnabledDate string
    The date when the account was made a delegated administrator.
    email string
    The email address that is associated with the delegated administrator's AWS account.
    id string
    The provider-assigned unique ID for this managed resource.
    joinedMethod string
    The method by which the delegated administrator's account joined the organization.
    joinedTimestamp string
    The date when the delegated administrator's account became a part of the organization.
    name string
    The friendly name of the delegated administrator's account.
    status string
    The status of the delegated administrator's account in the organization.
    arn str
    The Amazon Resource Name (ARN) of the delegated administrator's account.
    delegation_enabled_date str
    The date when the account was made a delegated administrator.
    email str
    The email address that is associated with the delegated administrator's AWS account.
    id str
    The provider-assigned unique ID for this managed resource.
    joined_method str
    The method by which the delegated administrator's account joined the organization.
    joined_timestamp str
    The date when the delegated administrator's account became a part of the organization.
    name str
    The friendly name of the delegated administrator's account.
    status str
    The status of the delegated administrator's account in the organization.
    arn String
    The Amazon Resource Name (ARN) of the delegated administrator's account.
    delegationEnabledDate String
    The date when the account was made a delegated administrator.
    email String
    The email address that is associated with the delegated administrator's AWS account.
    id String
    The provider-assigned unique ID for this managed resource.
    joinedMethod String
    The method by which the delegated administrator's account joined the organization.
    joinedTimestamp String
    The date when the delegated administrator's account became a part of the organization.
    name String
    The friendly name of the delegated administrator's account.
    status String
    The status of the delegated administrator's account in the organization.

    Look up Existing DelegatedAdministrator Resource

    Get an existing DelegatedAdministrator resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DelegatedAdministratorState, opts?: CustomResourceOptions): DelegatedAdministrator
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        arn: Optional[str] = None,
        delegation_enabled_date: Optional[str] = None,
        email: Optional[str] = None,
        joined_method: Optional[str] = None,
        joined_timestamp: Optional[str] = None,
        name: Optional[str] = None,
        service_principal: Optional[str] = None,
        status: Optional[str] = None) -> DelegatedAdministrator
    func GetDelegatedAdministrator(ctx *Context, name string, id IDInput, state *DelegatedAdministratorState, opts ...ResourceOption) (*DelegatedAdministrator, error)
    public static DelegatedAdministrator Get(string name, Input<string> id, DelegatedAdministratorState? state, CustomResourceOptions? opts = null)
    public static DelegatedAdministrator get(String name, Output<String> id, DelegatedAdministratorState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountId string
    The account ID number of the member account in the organization to register as a delegated administrator.
    Arn string
    The Amazon Resource Name (ARN) of the delegated administrator's account.
    DelegationEnabledDate string
    The date when the account was made a delegated administrator.
    Email string
    The email address that is associated with the delegated administrator's AWS account.
    JoinedMethod string
    The method by which the delegated administrator's account joined the organization.
    JoinedTimestamp string
    The date when the delegated administrator's account became a part of the organization.
    Name string
    The friendly name of the delegated administrator's account.
    ServicePrincipal string
    The service principal of the AWS service for which you want to make the member account a delegated administrator.
    Status string
    The status of the delegated administrator's account in the organization.
    AccountId string
    The account ID number of the member account in the organization to register as a delegated administrator.
    Arn string
    The Amazon Resource Name (ARN) of the delegated administrator's account.
    DelegationEnabledDate string
    The date when the account was made a delegated administrator.
    Email string
    The email address that is associated with the delegated administrator's AWS account.
    JoinedMethod string
    The method by which the delegated administrator's account joined the organization.
    JoinedTimestamp string
    The date when the delegated administrator's account became a part of the organization.
    Name string
    The friendly name of the delegated administrator's account.
    ServicePrincipal string
    The service principal of the AWS service for which you want to make the member account a delegated administrator.
    Status string
    The status of the delegated administrator's account in the organization.
    accountId String
    The account ID number of the member account in the organization to register as a delegated administrator.
    arn String
    The Amazon Resource Name (ARN) of the delegated administrator's account.
    delegationEnabledDate String
    The date when the account was made a delegated administrator.
    email String
    The email address that is associated with the delegated administrator's AWS account.
    joinedMethod String
    The method by which the delegated administrator's account joined the organization.
    joinedTimestamp String
    The date when the delegated administrator's account became a part of the organization.
    name String
    The friendly name of the delegated administrator's account.
    servicePrincipal String
    The service principal of the AWS service for which you want to make the member account a delegated administrator.
    status String
    The status of the delegated administrator's account in the organization.
    accountId string
    The account ID number of the member account in the organization to register as a delegated administrator.
    arn string
    The Amazon Resource Name (ARN) of the delegated administrator's account.
    delegationEnabledDate string
    The date when the account was made a delegated administrator.
    email string
    The email address that is associated with the delegated administrator's AWS account.
    joinedMethod string
    The method by which the delegated administrator's account joined the organization.
    joinedTimestamp string
    The date when the delegated administrator's account became a part of the organization.
    name string
    The friendly name of the delegated administrator's account.
    servicePrincipal string
    The service principal of the AWS service for which you want to make the member account a delegated administrator.
    status string
    The status of the delegated administrator's account in the organization.
    account_id str
    The account ID number of the member account in the organization to register as a delegated administrator.
    arn str
    The Amazon Resource Name (ARN) of the delegated administrator's account.
    delegation_enabled_date str
    The date when the account was made a delegated administrator.
    email str
    The email address that is associated with the delegated administrator's AWS account.
    joined_method str
    The method by which the delegated administrator's account joined the organization.
    joined_timestamp str
    The date when the delegated administrator's account became a part of the organization.
    name str
    The friendly name of the delegated administrator's account.
    service_principal str
    The service principal of the AWS service for which you want to make the member account a delegated administrator.
    status str
    The status of the delegated administrator's account in the organization.
    accountId String
    The account ID number of the member account in the organization to register as a delegated administrator.
    arn String
    The Amazon Resource Name (ARN) of the delegated administrator's account.
    delegationEnabledDate String
    The date when the account was made a delegated administrator.
    email String
    The email address that is associated with the delegated administrator's AWS account.
    joinedMethod String
    The method by which the delegated administrator's account joined the organization.
    joinedTimestamp String
    The date when the delegated administrator's account became a part of the organization.
    name String
    The friendly name of the delegated administrator's account.
    servicePrincipal String
    The service principal of the AWS service for which you want to make the member account a delegated administrator.
    status String
    The status of the delegated administrator's account in the organization.

    Import

    Using pulumi import, import aws_organizations_delegated_administrator using the account ID and its service principal. For example:

    $ pulumi import aws:organizations/delegatedAdministrator:DelegatedAdministrator example 123456789012/config.amazonaws.com

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws