generated from pulumi/pulumi-tf-provider-boilerplate
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
82 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,3 +4,52 @@ 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 >}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,53 @@ | ||
--- | ||
title: AWS Control Tower Setup | ||
title: AWS Control Tower Installation & Configuration | ||
meta_desc: Information on how to install the AWS Control Tower provider. | ||
layout: installation | ||
layout: package | ||
--- | ||
|
||
## Installation | ||
|
||
The Pulumi AWS Control Tower provider is available as a package in all Pulumi languages: | ||
|
||
* JavaScript/TypeScript: [`@lbrlabs/pulumi-awscontroltower`](https://www.npmjs.com/package/@lbrlabs/pulumi-awscontroltower) | ||
* Python: [`lbrlabs_pulumi_awscontroltower`](https://pypi.org/project/lbrlabs-pulumi-awscontroltower/) | ||
* Go: [`github.com/lbrlabs/pulumi-awscontroltower/sdk/go/awscontroltower`](https://pkg.go.dev/github.com/lbrlabs/pulumi-awscontroltower/sdk) | ||
* .NET: [`Lbrlabs.PulumiPackage.Awscontroltower`](https://www.nuget.org/packages/Lbrlabs.PulumiPackage.Awscontroltower) | ||
* 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. | ||
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 <version> | ||
pulumi plugin install resource awscontroltower --server github://api.github.com/lbrlabs | ||
``` | ||
|
||
Replace the version string with your desired version. | ||
|
||
## Setup | ||
|
||
Coming soon | ||
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. | ||
|
||
### Set environment variables | ||
{{% /choosable %}} | ||
|
||
Coming soon | ||
{{% 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`]({{< relref "/registry/packages/awscontroltower/api-docs/provider" >}}). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,4 +14,6 @@ resources: | |
firstName: "Lee" | ||
lastName: "Briggs" | ||
email: "[email protected]" | ||
options: | ||
pluginDownloadUrl: "github://api.github.com/lbrlabs" | ||
|