Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Aiven Provider
  4. API Docs
  5. ByocPermissions
Viewing docs for Aiven v6.55.0
published on Friday, May 22, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aiven

aiven.ByocPermissions

aiven logo
Viewing docs for Aiven v6.55.0
published on Friday, May 22, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aiven

    Manages permissions for a BYOC custom cloud environment, which accounts and projects can use the cloud to deploy services. Note! The `accounts` and `projects` lists are authoritative. This differs from the `avn byoc cloud permissions add`, which merges into the existing set. Create this resource after `aiven_byoc_aws_entity` and `aiven_byoc_aws_provision` so the custom cloud environment is active before permissions are granted.

    This resource is in the beta stage and may change without notice. Set the PROVIDER_AIVEN_ENABLE_BETA environment variable to use the resource. If this resource is missing (for example, after a service power off), it’s removed from the state and a new create plan is generated.

    Example Usage

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

const example = new aiven.ByocPermissions("example", {
    organizationId: "org1a23f456789",
    customCloudEnvironmentId: "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    accounts: ["a22ba494e096"],
    projects: ["project-prod"],
});

    import pulumi
import pulumi_aiven as aiven

example = aiven.ByocPermissions("example",
    organization_id="org1a23f456789",
    custom_cloud_environment_id="1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    accounts=["a22ba494e096"],
    projects=["project-prod"])

    package main

import (
	"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aiven.NewByocPermissions(ctx, "example", &aiven.ByocPermissionsArgs{
			OrganizationId:           pulumi.String("org1a23f456789"),
			CustomCloudEnvironmentId: pulumi.String("1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"),
			Accounts: pulumi.StringArray{
				pulumi.String("a22ba494e096"),
			},
			Projects: pulumi.StringArray{
				pulumi.String("project-prod"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Aiven.ByocPermissions("example", new()
    {
        OrganizationId = "org1a23f456789",
        CustomCloudEnvironmentId = "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
        Accounts = new[]
        {
            "a22ba494e096",
        },
        Projects = new[]
        {
            "project-prod",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.ByocPermissions;
import com.pulumi.aiven.ByocPermissionsArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 ByocPermissions("example", ByocPermissionsArgs.builder()
            .organizationId("org1a23f456789")
            .customCloudEnvironmentId("1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d")
            .accounts("a22ba494e096")
            .projects("project-prod")
            .build());

    }
}

    resources:
  example:
    type: aiven:ByocPermissions
    properties:
      organizationId: org1a23f456789
      customCloudEnvironmentId: 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d
      accounts:
        - a22ba494e096
      projects:
        - project-prod

    pulumi {
  required_providers {
    aiven = {
      source = "pulumi/aiven"
    }
  }
}

resource "aiven_byocpermissions" "example" {
  organization_id             = "org1a23f456789"
  custom_cloud_environment_id = "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
  accounts                    = ["a22ba494e096"]
  projects                    = ["project-prod"]
}

    Create ByocPermissions Resource

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

    Constructor syntax

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

@overload
def ByocPermissions(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    accounts: Optional[Sequence[str]] = None,
                    custom_cloud_environment_id: Optional[str] = None,
                    organization_id: Optional[str] = None,
                    projects: Optional[Sequence[str]] = None,
                    timeouts: Optional[ByocPermissionsTimeoutsArgs] = None)
    func NewByocPermissions(ctx *Context, name string, args ByocPermissionsArgs, opts ...ResourceOption) (*ByocPermissions, error)
    public ByocPermissions(string name, ByocPermissionsArgs args, CustomResourceOptions? opts = null)
    public ByocPermissions(String name, ByocPermissionsArgs args)
public ByocPermissions(String name, ByocPermissionsArgs args, CustomResourceOptions options)

    type: aiven:ByocPermissions
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "aiven_byocpermissions" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ByocPermissionsArgs
    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 ByocPermissionsArgs
    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 ByocPermissionsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ByocPermissionsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ByocPermissionsArgs
    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 byocPermissionsResource = new Aiven.ByocPermissions("byocPermissionsResource", new()
{
    Accounts = new[]
    {
        "string",
    },
    CustomCloudEnvironmentId = "string",
    OrganizationId = "string",
    Projects = new[]
    {
        "string",
    },
    Timeouts = new Aiven.Inputs.ByocPermissionsTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Read = "string",
        Update = "string",
    },
});

    example, err := aiven.NewByocPermissions(ctx, "byocPermissionsResource", &aiven.ByocPermissionsArgs{
	Accounts: pulumi.StringArray{
		pulumi.String("string"),
	},
	CustomCloudEnvironmentId: pulumi.String("string"),
	OrganizationId:           pulumi.String("string"),
	Projects: pulumi.StringArray{
		pulumi.String("string"),
	},
	Timeouts: &aiven.ByocPermissionsTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Read:   pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    resource "aiven_byocpermissions" "byocPermissionsResource" {
  accounts                    = ["string"]
  custom_cloud_environment_id = "string"
  organization_id             = "string"
  projects                    = ["string"]
  timeouts = {
    create = "string"
    delete = "string"
    read   = "string"
    update = "string"
  }
}

    var byocPermissionsResource = new ByocPermissions("byocPermissionsResource", ByocPermissionsArgs.builder()
    .accounts("string")
    .customCloudEnvironmentId("string")
    .organizationId("string")
    .projects("string")
    .timeouts(ByocPermissionsTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .read("string")
        .update("string")
        .build())
    .build());

    byoc_permissions_resource = aiven.ByocPermissions("byocPermissionsResource",
    accounts=["string"],
    custom_cloud_environment_id="string",
    organization_id="string",
    projects=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
    })

    const byocPermissionsResource = new aiven.ByocPermissions("byocPermissionsResource", {
    accounts: ["string"],
    customCloudEnvironmentId: "string",
    organizationId: "string",
    projects: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
        read: "string",
        update: "string",
    },
});

    type: aiven:ByocPermissions
properties:
    accounts:
        - string
    customCloudEnvironmentId: string
    organizationId: string
    projects:
        - string
    timeouts:
        create: string
        delete: string
        read: string
        update: string

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

    Accounts List<string>
    Accounts.
    CustomCloudEnvironmentId string
    ID of a custom cloud environment. Changing this property forces recreation of the resource.
    OrganizationId string
    ID of an organization. Changing this property forces recreation of the resource.
    Projects List<string>
    Projects.
    Timeouts ByocPermissionsTimeouts
    Accounts []string
    Accounts.
    CustomCloudEnvironmentId string
    ID of a custom cloud environment. Changing this property forces recreation of the resource.
    OrganizationId string
    ID of an organization. Changing this property forces recreation of the resource.
    Projects []string
    Projects.
    Timeouts ByocPermissionsTimeoutsArgs
    accounts list(string)
    Accounts.
    custom_cloud_environment_id string
    ID of a custom cloud environment. Changing this property forces recreation of the resource.
    organization_id string
    ID of an organization. Changing this property forces recreation of the resource.
    projects list(string)
    Projects.
    timeouts object
    accounts List<String>
    Accounts.
    customCloudEnvironmentId String
    ID of a custom cloud environment. Changing this property forces recreation of the resource.
    organizationId String
    ID of an organization. Changing this property forces recreation of the resource.
    projects List<String>
    Projects.
    timeouts ByocPermissionsTimeouts
    accounts string[]
    Accounts.
    customCloudEnvironmentId string
    ID of a custom cloud environment. Changing this property forces recreation of the resource.
    organizationId string
    ID of an organization. Changing this property forces recreation of the resource.
    projects string[]
    Projects.
    timeouts ByocPermissionsTimeouts
    accounts Sequence[str]
    Accounts.
    custom_cloud_environment_id str
    ID of a custom cloud environment. Changing this property forces recreation of the resource.
    organization_id str
    ID of an organization. Changing this property forces recreation of the resource.
    projects Sequence[str]
    Projects.
    timeouts ByocPermissionsTimeoutsArgs
    accounts List<String>
    Accounts.
    customCloudEnvironmentId String
    ID of a custom cloud environment. Changing this property forces recreation of the resource.
    organizationId String
    ID of an organization. Changing this property forces recreation of the resource.
    projects List<String>
    Projects.
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ByocPermissions 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 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 ByocPermissions Resource

    Get an existing ByocPermissions 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?: ByocPermissionsState, opts?: CustomResourceOptions): ByocPermissions
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        accounts: Optional[Sequence[str]] = None,
        custom_cloud_environment_id: Optional[str] = None,
        organization_id: Optional[str] = None,
        projects: Optional[Sequence[str]] = None,
        timeouts: Optional[ByocPermissionsTimeoutsArgs] = None) -> ByocPermissions
    func GetByocPermissions(ctx *Context, name string, id IDInput, state *ByocPermissionsState, opts ...ResourceOption) (*ByocPermissions, error)
    public static ByocPermissions Get(string name, Input<string> id, ByocPermissionsState? state, CustomResourceOptions? opts = null)
    public static ByocPermissions get(String name, Output<String> id, ByocPermissionsState state, CustomResourceOptions options)
    resources:  _:    type: aiven:ByocPermissions    get:      id: ${id}
    import {
  to = aiven_byocpermissions.example
  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:
    Accounts List<string>
    Accounts.
    CustomCloudEnvironmentId string
    ID of a custom cloud environment. Changing this property forces recreation of the resource.
    OrganizationId string
    ID of an organization. Changing this property forces recreation of the resource.
    Projects List<string>
    Projects.
    Timeouts ByocPermissionsTimeouts
    Accounts []string
    Accounts.
    CustomCloudEnvironmentId string
    ID of a custom cloud environment. Changing this property forces recreation of the resource.
    OrganizationId string
    ID of an organization. Changing this property forces recreation of the resource.
    Projects []string
    Projects.
    Timeouts ByocPermissionsTimeoutsArgs
    accounts list(string)
    Accounts.
    custom_cloud_environment_id string
    ID of a custom cloud environment. Changing this property forces recreation of the resource.
    organization_id string
    ID of an organization. Changing this property forces recreation of the resource.
    projects list(string)
    Projects.
    timeouts object
    accounts List<String>
    Accounts.
    customCloudEnvironmentId String
    ID of a custom cloud environment. Changing this property forces recreation of the resource.
    organizationId String
    ID of an organization. Changing this property forces recreation of the resource.
    projects List<String>
    Projects.
    timeouts ByocPermissionsTimeouts
    accounts string[]
    Accounts.
    customCloudEnvironmentId string
    ID of a custom cloud environment. Changing this property forces recreation of the resource.
    organizationId string
    ID of an organization. Changing this property forces recreation of the resource.
    projects string[]
    Projects.
    timeouts ByocPermissionsTimeouts
    accounts Sequence[str]
    Accounts.
    custom_cloud_environment_id str
    ID of a custom cloud environment. Changing this property forces recreation of the resource.
    organization_id str
    ID of an organization. Changing this property forces recreation of the resource.
    projects Sequence[str]
    Projects.
    timeouts ByocPermissionsTimeoutsArgs
    accounts List<String>
    Accounts.
    customCloudEnvironmentId String
    ID of a custom cloud environment. Changing this property forces recreation of the resource.
    organizationId String
    ID of an organization. Changing this property forces recreation of the resource.
    projects List<String>
    Projects.
    timeouts Property Map

    Supporting Types

    ByocPermissionsTimeouts, ByocPermissionsTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Import

    $ pulumi import aiven:index/byocPermissions:ByocPermissions example ORGANIZATION_ID/CUSTOM_CLOUD_ENVIRONMENT_ID

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

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo
    Viewing docs for Aiven v6.55.0
    published on Friday, May 22, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aiven

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial