|
1 | 1 | --- |
2 | 2 | layout: src/layouts/Default.astro |
3 | 3 | pubDate: 2023-01-01 |
4 | | -modDate: 2023-01-01 |
5 | | -title: Create AWS account command |
6 | | -description: New-OctopusAwsAccount allows you to create an AWS account in Octopus from within a running deployment |
| 4 | +modDate: 2026-04-08 |
| 5 | +title: Create AWS account commands |
| 6 | +description: New-OctopusAwsAccount and New-OctopusAwsOidcAccount allow you to create AWS accounts in Octopus from within a running deployment |
7 | 7 | navOrder: 10 |
8 | 8 | --- |
9 | 9 |
|
10 | 10 | ## AWS account |
11 | | -Command: **_New-OctopusAwsAccount_** |
12 | 11 |
|
13 | | -_**New-OctopusAwsAccount** allows you to create an AWS account in Octopus from within a running deployment_ |
| 12 | +Command: ***New-OctopusAwsAccount*** |
14 | 13 |
|
15 | | -| Parameters | Value | |
16 | | -|-------------------------------|------------------------------------------------------------------------------------------------------------| |
17 | | -| `-name` | Name for the AWS account | |
18 | | -| `-secretKey` | The AWS secret key to use when authenticating against Amazon Web Services. | |
19 | | -| `-accessKey` | The AWS access key to use when authenticating against Amazon Web Services. | |
20 | | -| `-updateIfExisting` | Will update an existing account with the same name, create if it doesn't exist | |
| 14 | +***New-OctopusAwsAccount*** *allows you to create an AWS account in Octopus from within a running deployment* |
| 15 | + |
| 16 | +| Parameters | Value | |
| 17 | +| ------------------- | -------------------------------------------------------------------------------- | |
| 18 | +| `-name` | Name for the AWS account. | |
| 19 | +| `-secretKey` | The AWS secret key to use when authenticating against Amazon Web Services. | |
| 20 | +| `-accessKey` | The AWS access key to use when authenticating against Amazon Web Services. | |
| 21 | +| `-region` | The AWS region to use for authentication (e.g. `us-east-1`). | |
| 22 | +| `-updateIfExisting` | Will update an existing account with the same name, create if it doesn't exist. | |
21 | 23 |
|
22 | 24 | Example: |
| 25 | + |
23 | 26 | ```powershell |
24 | 27 | New-OctopusAwsAccount -name "My AWS Account" ` |
25 | 28 | -secretKey "7U4MhdfjgcAk9niwPgXD81pTYY+fIvVsN3m" ` |
26 | 29 | -accessKey "AKIAVY29QTUTKPJC3R5K" ` |
| 30 | + -region "us-east-1" ` |
27 | 31 | -updateIfExisting |
28 | 32 | ``` |
| 33 | + |
| 34 | +## AWS OIDC account |
| 35 | + |
| 36 | +Command: ***New-OctopusAwsOidcAccount*** |
| 37 | + |
| 38 | +***New-OctopusAwsOidcAccount*** *allows you to create an AWS OIDC account in Octopus from within a running deployment* |
| 39 | + |
| 40 | +| Parameters | Value | |
| 41 | +| ------------------- | -------------------------------------------------------------------------------- | |
| 42 | +| `-name` | Name for the AWS OIDC account. | |
| 43 | +| `-roleArn` | The Amazon Resource Name (ARN) of the role to assume. | |
| 44 | +| `-sessionDuration` | The duration of the session in seconds. Defaults to `3600`. | |
| 45 | +| `-region` | The AWS region to use for authentication (e.g. `us-east-1`). | |
| 46 | +| `-updateIfExisting` | Will update an existing account with the same name, create if it doesn't exist. | |
| 47 | + |
| 48 | +Example: |
| 49 | + |
| 50 | +```powershell |
| 51 | +New-OctopusAwsOidcAccount -name "My AWS OIDC Account" ` |
| 52 | + -roleArn "arn:aws:iam::123456789012:role/my-role" ` |
| 53 | + -sessionDuration "3600" ` |
| 54 | + -region "ap-southeast-2" ` |
| 55 | + -updateIfExisting |
| 56 | +``` |
0 commit comments