Skip to content

Commit

Permalink
Publish Package Metadata [email protected] (#3369)
Browse files Browse the repository at this point in the history
* Publish Package Metadata for [email protected]

* **auto-fix relref lint errors**

* fix short code

---------

Co-authored-by: pulumi-bot <[email protected]>
Co-authored-by: Sean Holung <[email protected]>
  • Loading branch information
3 people authored Oct 23, 2023
1 parent f205962 commit 2073f8f
Show file tree
Hide file tree
Showing 3 changed files with 121 additions and 0 deletions.
55 changes: 55 additions & 0 deletions themes/default/content/registry/packages/awscontroltower/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: AWS Control Tower
meta_desc: Provides an overview of the AWS Control Tower package for Pulumi
layout: overview
---

The AWS Control Tower provider for Pulumi can be used to provision AWS account with [AWS Control Tower](https://aws.amazon.com/controltower/).

The AWS Control Tower provider must be configured with the required permissions to manage AWS accounts in AWS Control Tower.

## Example

{{< chooser language "typescript,python" >}}
{{% choosable language typescript %}}

```typescript

import * as controltower from "@lbrlabs/pulumi-awscontroltower";

const account = new controltower.ControlTowerAwsAccount("account", {
organizationalUnit: "Production",
email: "[email protected]",
name: "Some User",
organizationalUnitIdOnDelete: "ou-48hfnvbc-ufo",
closeAccountOnDelete: true,
sso: {
firstName: "Some",
lastName: "User",
email: "[email protected]",
},
});
```

{{% /choosable %}}
{{% choosable language python %}}

```python
import lbrlabs_pulumi_aws_controltower as controltower

account = controltower.ControlTowerAwsAccount(
"account",
organizational_unit="Production",
email="[email protected]",
name="Some User",
organizational_unit_id_on_delete="ou-48hfnvbc-ufo",
close_account_on_delete=True,
sso={
"firstName": "Some",
"lastName": "User",
"email": "[email protected]"
}
```

{{% /choosable %}}
{{< /chooser >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: AWS Control Tower Installation & Configuration
meta_desc: Information on how to install the AWS Control Tower provider.
layout: package
---

## Installation

The Pulumi AWS Control Tower provider is available as a package in all Pulumi languages:

* JavaScript/TypeScript: [`@lbrlabs/pulumi-awscontroltwer`](https://www.npmjs.com/package/@lbrlabs/pulumi-awscontroltwer)
* Python: [`lbrlabs_pulumi_aws_controltwer`](https://pypi.org/project/lbrlabs-pulumi-aws-controltower/)
* Go: [`github.com/lbrlabs/pulumi-awscontroltower/sdk/go/controltwer`](https://pkg.go.dev/github.com/lbrlabs/pulumi-awscontroltower/sdk)
* .NET: [`Lbrlabs.PulumiPackage.Scaleway`](https://www.nuget.org/packages/Lbrlabs.PulumiPackage.Awscontroltower)

### Provider Binary

The AWS control tower provider binary is a third party binary. It can be installed using the `pulumi plugin` command.

```bash
pulumi plugin install resource awscontroltower --server github://api.github.com/lbrlabs
```

Replace the version string with your desired version.

## Setup

The AWS control tower uses the AWS SDK to connect to AWS. Many of the authentication options you're familiar with using [Pulumi AWS)(https://www.pulumi.com/registry/packages/aws/) apply here.

{{< chooser os "macos,windows" >}}
{{% choosable os macos %}}

```bash
$ export AWS_ACCESS_KEY_ID=<AWS_ACCESS_KEY_ID>
$ export AWS_SECRET_ACCESS_KEY=<AWS_SECRET_ACCESS_KEY>
```

{{% /choosable %}}

{{% choosable os windows %}}

```powershell
> $env:AWS_ACCESS_KEY_ID = "<AWS_ACCESS_KEY_ID>"
> $env:AWS_SECRET_ACCESS_KEY = "<AWS_SECRET_ACCESS_KEY>"
```

{{% /choosable %}}
{{< /chooser >}}

## Configuration Options

Use `pulumi config set awscontroltower:<option>` or pass options to the [constructor of `new awscontroltower.Provider`](/registry/packages/awscontroltower/api-docs/provider).
14 changes: 14 additions & 0 deletions themes/default/data/registry/packages/awscontroltower.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
category: Cloud
component: false
description: A Pulumi package for creating and managing control tower accounts.
featured: false
logo_url: ""
name: awscontroltower
native: false
package_status: public_preview
publisher: lbrlabs
repo_url: https://github.com/lbrlabs/pulumi-awscontroltower
schema_file_path: provider/cmd/pulumi-resource-awscontroltower/schema.json
title: AWS Control Tower
updated_on: 1697818067
version: v0.0.2

0 comments on commit 2073f8f

Please sign in to comment.