1. Packages
  2. AWS Control Tower
  3. API Docs
  4. ControlTowerAwsAccount
AWS Control Tower v0.0.2 published on Friday, Oct 20, 2023 by lbrlabs

awscontroltower.ControlTowerAwsAccount

Explore with Pulumi AI

awscontroltower logo
AWS Control Tower v0.0.2 published on Friday, Oct 20, 2023 by lbrlabs

    Create ControlTowerAwsAccount Resource

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

    Constructor syntax

    new ControlTowerAwsAccount(name: string, args: ControlTowerAwsAccountArgs, opts?: CustomResourceOptions);
    @overload
    def ControlTowerAwsAccount(resource_name: str,
                               args: ControlTowerAwsAccountArgs,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def ControlTowerAwsAccount(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               email: Optional[str] = None,
                               organizational_unit: Optional[str] = None,
                               sso: Optional[ControlTowerAwsAccountSsoArgs] = None,
                               close_account_on_delete: Optional[bool] = None,
                               name: Optional[str] = None,
                               organizational_unit_id_on_delete: Optional[str] = None,
                               path_id: Optional[str] = None,
                               provisioned_product_name: Optional[str] = None,
                               tags: Optional[Mapping[str, str]] = None)
    func NewControlTowerAwsAccount(ctx *Context, name string, args ControlTowerAwsAccountArgs, opts ...ResourceOption) (*ControlTowerAwsAccount, error)
    public ControlTowerAwsAccount(string name, ControlTowerAwsAccountArgs args, CustomResourceOptions? opts = null)
    public ControlTowerAwsAccount(String name, ControlTowerAwsAccountArgs args)
    public ControlTowerAwsAccount(String name, ControlTowerAwsAccountArgs args, CustomResourceOptions options)
    
    type: awscontroltower:index/controlTowerAwsAccount:controlTowerAwsAccount
    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 ControlTowerAwsAccountArgs
    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 ControlTowerAwsAccountArgs
    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 ControlTowerAwsAccountArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ControlTowerAwsAccountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ControlTowerAwsAccountArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var controlTowerAwsAccountResource = new Awscontroltower.ControlTowerAwsAccount("controlTowerAwsAccountResource", new()
    {
        Email = "string",
        OrganizationalUnit = "string",
        Sso = new Awscontroltower.Inputs.ControlTowerAwsAccountSsoArgs
        {
            Email = "string",
            FirstName = "string",
            LastName = "string",
        },
        CloseAccountOnDelete = false,
        Name = "string",
        OrganizationalUnitIdOnDelete = "string",
        PathId = "string",
        ProvisionedProductName = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := awscontroltower.NewcontrolTowerAwsAccount(ctx, "controlTowerAwsAccountResource", &awscontroltower.controlTowerAwsAccountArgs{
    	Email:              pulumi.String("string"),
    	OrganizationalUnit: pulumi.String("string"),
    	Sso: &awscontroltower.ControlTowerAwsAccountSsoArgs{
    		Email:     pulumi.String("string"),
    		FirstName: pulumi.String("string"),
    		LastName:  pulumi.String("string"),
    	},
    	CloseAccountOnDelete:         pulumi.Bool(false),
    	Name:                         pulumi.String("string"),
    	OrganizationalUnitIdOnDelete: pulumi.String("string"),
    	PathId:                       pulumi.String("string"),
    	ProvisionedProductName:       pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var controlTowerAwsAccountResource = new ControlTowerAwsAccount("controlTowerAwsAccountResource", ControlTowerAwsAccountArgs.builder()        
        .email("string")
        .organizationalUnit("string")
        .sso(ControlTowerAwsAccountSsoArgs.builder()
            .email("string")
            .firstName("string")
            .lastName("string")
            .build())
        .closeAccountOnDelete(false)
        .name("string")
        .organizationalUnitIdOnDelete("string")
        .pathId("string")
        .provisionedProductName("string")
        .tags(Map.of("string", "string"))
        .build());
    
    control_tower_aws_account_resource = awscontroltower.ControlTowerAwsAccount("controlTowerAwsAccountResource",
        email="string",
        organizational_unit="string",
        sso=awscontroltower.ControlTowerAwsAccountSsoArgs(
            email="string",
            first_name="string",
            last_name="string",
        ),
        close_account_on_delete=False,
        name="string",
        organizational_unit_id_on_delete="string",
        path_id="string",
        provisioned_product_name="string",
        tags={
            "string": "string",
        })
    
    const controlTowerAwsAccountResource = new awscontroltower.ControlTowerAwsAccount("controlTowerAwsAccountResource", {
        email: "string",
        organizationalUnit: "string",
        sso: {
            email: "string",
            firstName: "string",
            lastName: "string",
        },
        closeAccountOnDelete: false,
        name: "string",
        organizationalUnitIdOnDelete: "string",
        pathId: "string",
        provisionedProductName: "string",
        tags: {
            string: "string",
        },
    });
    
    Coming soon!
    

    ControlTowerAwsAccount Resource Properties

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

    Inputs

    The ControlTowerAwsAccount resource accepts the following input properties:

    Email string
    Root email of the account.
    OrganizationalUnit string
    Name of the Organizational Unit under which the account resides.
    Sso Lbrlabs.PulumiPackage.Awscontroltower.Inputs.ControlTowerAwsAccountSsoArgs
    Assigned SSO user settings.
    CloseAccountOnDelete bool
    If enabled, this will close the AWS account on resource deletion, beginning the 90-day suspension period. Otherwise, the account will just be unenrolled from Control Tower.
    Name string
    Name of the account.
    OrganizationalUnitIdOnDelete string
    ID of the Organizational Unit to which the account should be moved when the resource is deleted. If no value is provided, the account will not be moved.
    PathId string
    Name of the path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.
    ProvisionedProductName string
    Name of the service catalog product that is provisioned. Defaults to a slugified version of the account name.
    Tags Dictionary<string, string>
    Key-value map of resource tags for the account.
    Email string
    Root email of the account.
    OrganizationalUnit string
    Name of the Organizational Unit under which the account resides.
    Sso ControlTowerAwsAccountSsoArgs
    Assigned SSO user settings.
    CloseAccountOnDelete bool
    If enabled, this will close the AWS account on resource deletion, beginning the 90-day suspension period. Otherwise, the account will just be unenrolled from Control Tower.
    Name string
    Name of the account.
    OrganizationalUnitIdOnDelete string
    ID of the Organizational Unit to which the account should be moved when the resource is deleted. If no value is provided, the account will not be moved.
    PathId string
    Name of the path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.
    ProvisionedProductName string
    Name of the service catalog product that is provisioned. Defaults to a slugified version of the account name.
    Tags map[string]string
    Key-value map of resource tags for the account.
    email String
    Root email of the account.
    organizationalUnit String
    Name of the Organizational Unit under which the account resides.
    sso ControlTowerAwsAccountSsoArgs
    Assigned SSO user settings.
    closeAccountOnDelete Boolean
    If enabled, this will close the AWS account on resource deletion, beginning the 90-day suspension period. Otherwise, the account will just be unenrolled from Control Tower.
    name String
    Name of the account.
    organizationalUnitIdOnDelete String
    ID of the Organizational Unit to which the account should be moved when the resource is deleted. If no value is provided, the account will not be moved.
    pathId String
    Name of the path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.
    provisionedProductName String
    Name of the service catalog product that is provisioned. Defaults to a slugified version of the account name.
    tags Map<String,String>
    Key-value map of resource tags for the account.
    email string
    Root email of the account.
    organizationalUnit string
    Name of the Organizational Unit under which the account resides.
    sso ControlTowerAwsAccountSsoArgs
    Assigned SSO user settings.
    closeAccountOnDelete boolean
    If enabled, this will close the AWS account on resource deletion, beginning the 90-day suspension period. Otherwise, the account will just be unenrolled from Control Tower.
    name string
    Name of the account.
    organizationalUnitIdOnDelete string
    ID of the Organizational Unit to which the account should be moved when the resource is deleted. If no value is provided, the account will not be moved.
    pathId string
    Name of the path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.
    provisionedProductName string
    Name of the service catalog product that is provisioned. Defaults to a slugified version of the account name.
    tags {[key: string]: string}
    Key-value map of resource tags for the account.
    email str
    Root email of the account.
    organizational_unit str
    Name of the Organizational Unit under which the account resides.
    sso ControlTowerAwsAccountSsoArgs
    Assigned SSO user settings.
    close_account_on_delete bool
    If enabled, this will close the AWS account on resource deletion, beginning the 90-day suspension period. Otherwise, the account will just be unenrolled from Control Tower.
    name str
    Name of the account.
    organizational_unit_id_on_delete str
    ID of the Organizational Unit to which the account should be moved when the resource is deleted. If no value is provided, the account will not be moved.
    path_id str
    Name of the path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.
    provisioned_product_name str
    Name of the service catalog product that is provisioned. Defaults to a slugified version of the account name.
    tags Mapping[str, str]
    Key-value map of resource tags for the account.
    email String
    Root email of the account.
    organizationalUnit String
    Name of the Organizational Unit under which the account resides.
    sso Property Map
    Assigned SSO user settings.
    closeAccountOnDelete Boolean
    If enabled, this will close the AWS account on resource deletion, beginning the 90-day suspension period. Otherwise, the account will just be unenrolled from Control Tower.
    name String
    Name of the account.
    organizationalUnitIdOnDelete String
    ID of the Organizational Unit to which the account should be moved when the resource is deleted. If no value is provided, the account will not be moved.
    pathId String
    Name of the path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.
    provisionedProductName String
    Name of the service catalog product that is provisioned. Defaults to a slugified version of the account name.
    tags Map<String>
    Key-value map of resource tags for the account.

    Outputs

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

    AccountId string
    ID of the AWS account.
    Id string
    The provider-assigned unique ID for this managed resource.
    AccountId string
    ID of the AWS account.
    Id string
    The provider-assigned unique ID for this managed resource.
    accountId String
    ID of the AWS account.
    id String
    The provider-assigned unique ID for this managed resource.
    accountId string
    ID of the AWS account.
    id string
    The provider-assigned unique ID for this managed resource.
    account_id str
    ID of the AWS account.
    id str
    The provider-assigned unique ID for this managed resource.
    accountId String
    ID of the AWS account.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ControlTowerAwsAccount Resource

    Get an existing ControlTowerAwsAccount 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?: ControlTowerAwsAccountState, opts?: CustomResourceOptions): ControlTowerAwsAccount
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            close_account_on_delete: Optional[bool] = None,
            email: Optional[str] = None,
            name: Optional[str] = None,
            organizational_unit: Optional[str] = None,
            organizational_unit_id_on_delete: Optional[str] = None,
            path_id: Optional[str] = None,
            provisioned_product_name: Optional[str] = None,
            sso: Optional[ControlTowerAwsAccountSsoArgs] = None,
            tags: Optional[Mapping[str, str]] = None) -> ControlTowerAwsAccount
    func GetControlTowerAwsAccount(ctx *Context, name string, id IDInput, state *ControlTowerAwsAccountState, opts ...ResourceOption) (*ControlTowerAwsAccount, error)
    public static ControlTowerAwsAccount Get(string name, Input<string> id, ControlTowerAwsAccountState? state, CustomResourceOptions? opts = null)
    public static ControlTowerAwsAccount get(String name, Output<String> id, ControlTowerAwsAccountState 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
    ID of the AWS account.
    CloseAccountOnDelete bool
    If enabled, this will close the AWS account on resource deletion, beginning the 90-day suspension period. Otherwise, the account will just be unenrolled from Control Tower.
    Email string
    Root email of the account.
    Name string
    Name of the account.
    OrganizationalUnit string
    Name of the Organizational Unit under which the account resides.
    OrganizationalUnitIdOnDelete string
    ID of the Organizational Unit to which the account should be moved when the resource is deleted. If no value is provided, the account will not be moved.
    PathId string
    Name of the path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.
    ProvisionedProductName string
    Name of the service catalog product that is provisioned. Defaults to a slugified version of the account name.
    Sso Lbrlabs.PulumiPackage.Awscontroltower.Inputs.ControlTowerAwsAccountSsoArgs
    Assigned SSO user settings.
    Tags Dictionary<string, string>
    Key-value map of resource tags for the account.
    AccountId string
    ID of the AWS account.
    CloseAccountOnDelete bool
    If enabled, this will close the AWS account on resource deletion, beginning the 90-day suspension period. Otherwise, the account will just be unenrolled from Control Tower.
    Email string
    Root email of the account.
    Name string
    Name of the account.
    OrganizationalUnit string
    Name of the Organizational Unit under which the account resides.
    OrganizationalUnitIdOnDelete string
    ID of the Organizational Unit to which the account should be moved when the resource is deleted. If no value is provided, the account will not be moved.
    PathId string
    Name of the path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.
    ProvisionedProductName string
    Name of the service catalog product that is provisioned. Defaults to a slugified version of the account name.
    Sso ControlTowerAwsAccountSsoArgs
    Assigned SSO user settings.
    Tags map[string]string
    Key-value map of resource tags for the account.
    accountId String
    ID of the AWS account.
    closeAccountOnDelete Boolean
    If enabled, this will close the AWS account on resource deletion, beginning the 90-day suspension period. Otherwise, the account will just be unenrolled from Control Tower.
    email String
    Root email of the account.
    name String
    Name of the account.
    organizationalUnit String
    Name of the Organizational Unit under which the account resides.
    organizationalUnitIdOnDelete String
    ID of the Organizational Unit to which the account should be moved when the resource is deleted. If no value is provided, the account will not be moved.
    pathId String
    Name of the path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.
    provisionedProductName String
    Name of the service catalog product that is provisioned. Defaults to a slugified version of the account name.
    sso ControlTowerAwsAccountSsoArgs
    Assigned SSO user settings.
    tags Map<String,String>
    Key-value map of resource tags for the account.
    accountId string
    ID of the AWS account.
    closeAccountOnDelete boolean
    If enabled, this will close the AWS account on resource deletion, beginning the 90-day suspension period. Otherwise, the account will just be unenrolled from Control Tower.
    email string
    Root email of the account.
    name string
    Name of the account.
    organizationalUnit string
    Name of the Organizational Unit under which the account resides.
    organizationalUnitIdOnDelete string
    ID of the Organizational Unit to which the account should be moved when the resource is deleted. If no value is provided, the account will not be moved.
    pathId string
    Name of the path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.
    provisionedProductName string
    Name of the service catalog product that is provisioned. Defaults to a slugified version of the account name.
    sso ControlTowerAwsAccountSsoArgs
    Assigned SSO user settings.
    tags {[key: string]: string}
    Key-value map of resource tags for the account.
    account_id str
    ID of the AWS account.
    close_account_on_delete bool
    If enabled, this will close the AWS account on resource deletion, beginning the 90-day suspension period. Otherwise, the account will just be unenrolled from Control Tower.
    email str
    Root email of the account.
    name str
    Name of the account.
    organizational_unit str
    Name of the Organizational Unit under which the account resides.
    organizational_unit_id_on_delete str
    ID of the Organizational Unit to which the account should be moved when the resource is deleted. If no value is provided, the account will not be moved.
    path_id str
    Name of the path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.
    provisioned_product_name str
    Name of the service catalog product that is provisioned. Defaults to a slugified version of the account name.
    sso ControlTowerAwsAccountSsoArgs
    Assigned SSO user settings.
    tags Mapping[str, str]
    Key-value map of resource tags for the account.
    accountId String
    ID of the AWS account.
    closeAccountOnDelete Boolean
    If enabled, this will close the AWS account on resource deletion, beginning the 90-day suspension period. Otherwise, the account will just be unenrolled from Control Tower.
    email String
    Root email of the account.
    name String
    Name of the account.
    organizationalUnit String
    Name of the Organizational Unit under which the account resides.
    organizationalUnitIdOnDelete String
    ID of the Organizational Unit to which the account should be moved when the resource is deleted. If no value is provided, the account will not be moved.
    pathId String
    Name of the path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.
    provisionedProductName String
    Name of the service catalog product that is provisioned. Defaults to a slugified version of the account name.
    sso Property Map
    Assigned SSO user settings.
    tags Map<String>
    Key-value map of resource tags for the account.

    Supporting Types

    ControlTowerAwsAccountSso, ControlTowerAwsAccountSsoArgs

    Email string
    FirstName string
    LastName string
    Email string
    FirstName string
    LastName string
    email String
    firstName String
    lastName String
    email string
    firstName string
    lastName string
    email String
    firstName String
    lastName String

    Package Details

    Repository
    awscontroltower lbrlabs/pulumi-awscontroltower
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the awscontroltower Terraform Provider.
    awscontroltower logo
    AWS Control Tower v0.0.2 published on Friday, Oct 20, 2023 by lbrlabs