Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. AwsAccount
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

octopusdeploy.AwsAccount

Explore with Pulumi AI

octopusdeploy logo
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

    This resource manages AWS accounts in Octopus Deploy.

    Example Usage

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

const example = new octopusdeploy.AwsAccount("example", {
    accessKey: "access-key",
    secretKey: "###########",
});
// required; get from secure environment/store

    import pulumi
import pulumi_octopusdeploy as octopusdeploy

example = octopusdeploy.AwsAccount("example",
    access_key="access-key",
    secret_key="###########")
# required; get from secure environment/store

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/octopusdeploy/octopusdeploy"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := octopusdeploy.NewAwsAccount(ctx, "example", &octopusdeploy.AwsAccountArgs{
			AccessKey: pulumi.String("access-key"),
			SecretKey: pulumi.String("###########"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Octopusdeploy.AwsAccount("example", new()
    {
        AccessKey = "access-key",
        SecretKey = "###########",
    });

    // required; get from secure environment/store
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.octopusdeploy.AwsAccount;
import com.pulumi.octopusdeploy.AwsAccountArgs;
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 AwsAccount("example", AwsAccountArgs.builder()
            .accessKey("access-key")
            .secretKey("###########")
            .build());

        // required; get from secure environment/store
    }
}

    resources:
  example:
    type: octopusdeploy:AwsAccount
    properties:
      accessKey: access-key
      secretKey: '###########'

    Create AwsAccount Resource

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

    Constructor syntax

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

@overload
def AwsAccount(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               access_key: Optional[str] = None,
               secret_key: Optional[str] = None,
               aws_account_id: Optional[str] = None,
               description: Optional[str] = None,
               environments: Optional[Sequence[str]] = None,
               name: Optional[str] = None,
               space_id: Optional[str] = None,
               tenant_tags: Optional[Sequence[str]] = None,
               tenanted_deployment_participation: Optional[str] = None,
               tenants: Optional[Sequence[str]] = None)
    func NewAwsAccount(ctx *Context, name string, args AwsAccountArgs, opts ...ResourceOption) (*AwsAccount, error)
    public AwsAccount(string name, AwsAccountArgs args, CustomResourceOptions? opts = null)
    public AwsAccount(String name, AwsAccountArgs args)
public AwsAccount(String name, AwsAccountArgs args, CustomResourceOptions options)

    type: octopusdeploy:AwsAccount
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 AwsAccountArgs
    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 AwsAccountArgs
    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 AwsAccountArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AwsAccountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AwsAccountArgs
    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 awsAccountResource = new Octopusdeploy.AwsAccount("awsAccountResource", new()
{
    AccessKey = "string",
    SecretKey = "string",
    AwsAccountId = "string",
    Description = "string",
    Environments = new[]
    {
        "string",
    },
    Name = "string",
    SpaceId = "string",
    TenantTags = new[]
    {
        "string",
    },
    TenantedDeploymentParticipation = "string",
    Tenants = new[]
    {
        "string",
    },
});

    example, err := octopusdeploy.NewAwsAccount(ctx, "awsAccountResource", &octopusdeploy.AwsAccountArgs{
	AccessKey:    pulumi.String("string"),
	SecretKey:    pulumi.String("string"),
	AwsAccountId: pulumi.String("string"),
	Description:  pulumi.String("string"),
	Environments: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:    pulumi.String("string"),
	SpaceId: pulumi.String("string"),
	TenantTags: pulumi.StringArray{
		pulumi.String("string"),
	},
	TenantedDeploymentParticipation: pulumi.String("string"),
	Tenants: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var awsAccountResource = new AwsAccount("awsAccountResource", AwsAccountArgs.builder()
    .accessKey("string")
    .secretKey("string")
    .awsAccountId("string")
    .description("string")
    .environments("string")
    .name("string")
    .spaceId("string")
    .tenantTags("string")
    .tenantedDeploymentParticipation("string")
    .tenants("string")
    .build());

    aws_account_resource = octopusdeploy.AwsAccount("awsAccountResource",
    access_key="string",
    secret_key="string",
    aws_account_id="string",
    description="string",
    environments=["string"],
    name="string",
    space_id="string",
    tenant_tags=["string"],
    tenanted_deployment_participation="string",
    tenants=["string"])

    const awsAccountResource = new octopusdeploy.AwsAccount("awsAccountResource", {
    accessKey: "string",
    secretKey: "string",
    awsAccountId: "string",
    description: "string",
    environments: ["string"],
    name: "string",
    spaceId: "string",
    tenantTags: ["string"],
    tenantedDeploymentParticipation: "string",
    tenants: ["string"],
});

    type: octopusdeploy:AwsAccount
properties:
    accessKey: string
    awsAccountId: string
    description: string
    environments:
        - string
    name: string
    secretKey: string
    spaceId: string
    tenantTags:
        - string
    tenantedDeploymentParticipation: string
    tenants:
        - string

    AwsAccount 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 AwsAccount resource accepts the following input properties:

    AccessKey string
    The access key associated with this AWS account.
    SecretKey string
    The secret key associated with this resource.
    AwsAccountId string
    The ID of this resource.
    Description string
    A user-friendly description of this AWS account.
    Environments List<string>
    A list of environment IDs associated with this resource.
    Name string
    The name of this AWS account.
    SpaceId string
    The space ID associated with this resource.
    TenantTags List<string>
    A list of tenant tags associated with this resource.
    TenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    Tenants List<string>
    A list of tenant IDs associated with this resource.
    AccessKey string
    The access key associated with this AWS account.
    SecretKey string
    The secret key associated with this resource.
    AwsAccountId string
    The ID of this resource.
    Description string
    A user-friendly description of this AWS account.
    Environments []string
    A list of environment IDs associated with this resource.
    Name string
    The name of this AWS account.
    SpaceId string
    The space ID associated with this resource.
    TenantTags []string
    A list of tenant tags associated with this resource.
    TenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    Tenants []string
    A list of tenant IDs associated with this resource.
    accessKey String
    The access key associated with this AWS account.
    secretKey String
    The secret key associated with this resource.
    awsAccountId String
    The ID of this resource.
    description String
    A user-friendly description of this AWS account.
    environments List<String>
    A list of environment IDs associated with this resource.
    name String
    The name of this AWS account.
    spaceId String
    The space ID associated with this resource.
    tenantTags List<String>
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation String
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants List<String>
    A list of tenant IDs associated with this resource.
    accessKey string
    The access key associated with this AWS account.
    secretKey string
    The secret key associated with this resource.
    awsAccountId string
    The ID of this resource.
    description string
    A user-friendly description of this AWS account.
    environments string[]
    A list of environment IDs associated with this resource.
    name string
    The name of this AWS account.
    spaceId string
    The space ID associated with this resource.
    tenantTags string[]
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants string[]
    A list of tenant IDs associated with this resource.
    access_key str
    The access key associated with this AWS account.
    secret_key str
    The secret key associated with this resource.
    aws_account_id str
    The ID of this resource.
    description str
    A user-friendly description of this AWS account.
    environments Sequence[str]
    A list of environment IDs associated with this resource.
    name str
    The name of this AWS account.
    space_id str
    The space ID associated with this resource.
    tenant_tags Sequence[str]
    A list of tenant tags associated with this resource.
    tenanted_deployment_participation str
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants Sequence[str]
    A list of tenant IDs associated with this resource.
    accessKey String
    The access key associated with this AWS account.
    secretKey String
    The secret key associated with this resource.
    awsAccountId String
    The ID of this resource.
    description String
    A user-friendly description of this AWS account.
    environments List<String>
    A list of environment IDs associated with this resource.
    name String
    The name of this AWS account.
    spaceId String
    The space ID associated with this resource.
    tenantTags List<String>
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation String
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants List<String>
    A list of tenant IDs associated with this resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AwsAccount Resource

    Get an existing AwsAccount 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?: AwsAccountState, opts?: CustomResourceOptions): AwsAccount
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_key: Optional[str] = None,
        aws_account_id: Optional[str] = None,
        description: Optional[str] = None,
        environments: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        secret_key: Optional[str] = None,
        space_id: Optional[str] = None,
        tenant_tags: Optional[Sequence[str]] = None,
        tenanted_deployment_participation: Optional[str] = None,
        tenants: Optional[Sequence[str]] = None) -> AwsAccount
    func GetAwsAccount(ctx *Context, name string, id IDInput, state *AwsAccountState, opts ...ResourceOption) (*AwsAccount, error)
    public static AwsAccount Get(string name, Input<string> id, AwsAccountState? state, CustomResourceOptions? opts = null)
    public static AwsAccount get(String name, Output<String> id, AwsAccountState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:AwsAccount    get:      id: ${id}
    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:
    AccessKey string
    The access key associated with this AWS account.
    AwsAccountId string
    The ID of this resource.
    Description string
    A user-friendly description of this AWS account.
    Environments List<string>
    A list of environment IDs associated with this resource.
    Name string
    The name of this AWS account.
    SecretKey string
    The secret key associated with this resource.
    SpaceId string
    The space ID associated with this resource.
    TenantTags List<string>
    A list of tenant tags associated with this resource.
    TenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    Tenants List<string>
    A list of tenant IDs associated with this resource.
    AccessKey string
    The access key associated with this AWS account.
    AwsAccountId string
    The ID of this resource.
    Description string
    A user-friendly description of this AWS account.
    Environments []string
    A list of environment IDs associated with this resource.
    Name string
    The name of this AWS account.
    SecretKey string
    The secret key associated with this resource.
    SpaceId string
    The space ID associated with this resource.
    TenantTags []string
    A list of tenant tags associated with this resource.
    TenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    Tenants []string
    A list of tenant IDs associated with this resource.
    accessKey String
    The access key associated with this AWS account.
    awsAccountId String
    The ID of this resource.
    description String
    A user-friendly description of this AWS account.
    environments List<String>
    A list of environment IDs associated with this resource.
    name String
    The name of this AWS account.
    secretKey String
    The secret key associated with this resource.
    spaceId String
    The space ID associated with this resource.
    tenantTags List<String>
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation String
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants List<String>
    A list of tenant IDs associated with this resource.
    accessKey string
    The access key associated with this AWS account.
    awsAccountId string
    The ID of this resource.
    description string
    A user-friendly description of this AWS account.
    environments string[]
    A list of environment IDs associated with this resource.
    name string
    The name of this AWS account.
    secretKey string
    The secret key associated with this resource.
    spaceId string
    The space ID associated with this resource.
    tenantTags string[]
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants string[]
    A list of tenant IDs associated with this resource.
    access_key str
    The access key associated with this AWS account.
    aws_account_id str
    The ID of this resource.
    description str
    A user-friendly description of this AWS account.
    environments Sequence[str]
    A list of environment IDs associated with this resource.
    name str
    The name of this AWS account.
    secret_key str
    The secret key associated with this resource.
    space_id str
    The space ID associated with this resource.
    tenant_tags Sequence[str]
    A list of tenant tags associated with this resource.
    tenanted_deployment_participation str
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants Sequence[str]
    A list of tenant IDs associated with this resource.
    accessKey String
    The access key associated with this AWS account.
    awsAccountId String
    The ID of this resource.
    description String
    A user-friendly description of this AWS account.
    environments List<String>
    A list of environment IDs associated with this resource.
    name String
    The name of this AWS account.
    secretKey String
    The secret key associated with this resource.
    spaceId String
    The space ID associated with this resource.
    tenantTags List<String>
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation String
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants List<String>
    A list of tenant IDs associated with this resource.

    Import

    $ pulumi import octopusdeploy:index/awsAccount:AwsAccount [options] octopusdeploy_aws_account.<name> <account-id>

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

    Package Details

    Repository
    octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
    License
    Notes
    This Pulumi package is based on the octopusdeploy Terraform Provider.
    octopusdeploy logo
    octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
    octopusdeploylabs/terraform-provider-octopusdeploy