Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. SystemAccount
konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect

konnect.SystemAccount

Explore with Pulumi AI

konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect

SystemAccount Resource

Example Usage

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

const mySystemaccount = new konnect.SystemAccount("mySystemaccount", {
    description: "...my_description...",
    konnectManaged: false,
});
Copy
import pulumi
import pulumi_konnect as konnect

my_systemaccount = konnect.SystemAccount("mySystemaccount",
    description="...my_description...",
    konnect_managed=False)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := konnect.NewSystemAccount(ctx, "mySystemaccount", &konnect.SystemAccountArgs{
			Description:    pulumi.String("...my_description..."),
			KonnectManaged: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Konnect = Pulumi.Konnect;

return await Deployment.RunAsync(() => 
{
    var mySystemaccount = new Konnect.SystemAccount("mySystemaccount", new()
    {
        Description = "...my_description...",
        KonnectManaged = false,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.SystemAccount;
import com.pulumi.konnect.SystemAccountArgs;
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 mySystemaccount = new SystemAccount("mySystemaccount", SystemAccountArgs.builder()
            .description("...my_description...")
            .konnectManaged(false)
            .build());

    }
}
Copy
resources:
  mySystemaccount:
    type: konnect:SystemAccount
    properties:
      description: '...my_description...'
      konnectManaged: false
Copy

Create SystemAccount Resource

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

Constructor syntax

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

@overload
def SystemAccount(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  description: Optional[str] = None,
                  konnect_managed: Optional[bool] = None,
                  name: Optional[str] = None)
func NewSystemAccount(ctx *Context, name string, args SystemAccountArgs, opts ...ResourceOption) (*SystemAccount, error)
public SystemAccount(string name, SystemAccountArgs args, CustomResourceOptions? opts = null)
public SystemAccount(String name, SystemAccountArgs args)
public SystemAccount(String name, SystemAccountArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SystemAccountArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SystemAccountArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SystemAccountArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SystemAccountArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SystemAccountArgs
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 systemAccountResource = new Konnect.SystemAccount("systemAccountResource", new()
{
    Description = "string",
    KonnectManaged = false,
    Name = "string",
});
Copy
example, err := konnect.NewSystemAccount(ctx, "systemAccountResource", &konnect.SystemAccountArgs{
	Description:    pulumi.String("string"),
	KonnectManaged: pulumi.Bool(false),
	Name:           pulumi.String("string"),
})
Copy
var systemAccountResource = new SystemAccount("systemAccountResource", SystemAccountArgs.builder()
    .description("string")
    .konnectManaged(false)
    .name("string")
    .build());
Copy
system_account_resource = konnect.SystemAccount("systemAccountResource",
    description="string",
    konnect_managed=False,
    name="string")
Copy
const systemAccountResource = new konnect.SystemAccount("systemAccountResource", {
    description: "string",
    konnectManaged: false,
    name: "string",
});
Copy
type: konnect:SystemAccount
properties:
    description: string
    konnectManaged: false
    name: string
Copy

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

Description This property is required. string
Description of the system account. Useful when the system account name is not sufficient to differentiate one system account from another.
KonnectManaged bool
The system account is managed by Konnect (true/false). Requires replacement if changed.
Name string
Name of the system account.
Description This property is required. string
Description of the system account. Useful when the system account name is not sufficient to differentiate one system account from another.
KonnectManaged bool
The system account is managed by Konnect (true/false). Requires replacement if changed.
Name string
Name of the system account.
description This property is required. String
Description of the system account. Useful when the system account name is not sufficient to differentiate one system account from another.
konnectManaged Boolean
The system account is managed by Konnect (true/false). Requires replacement if changed.
name String
Name of the system account.
description This property is required. string
Description of the system account. Useful when the system account name is not sufficient to differentiate one system account from another.
konnectManaged boolean
The system account is managed by Konnect (true/false). Requires replacement if changed.
name string
Name of the system account.
description This property is required. str
Description of the system account. Useful when the system account name is not sufficient to differentiate one system account from another.
konnect_managed bool
The system account is managed by Konnect (true/false). Requires replacement if changed.
name str
Name of the system account.
description This property is required. String
Description of the system account. Useful when the system account name is not sufficient to differentiate one system account from another.
konnectManaged Boolean
The system account is managed by Konnect (true/false). Requires replacement if changed.
name String
Name of the system account.

Outputs

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

CreatedAt string
Timestamp of when the system account was created.
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt string
Timestamp of when the system account was last updated.
CreatedAt string
Timestamp of when the system account was created.
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt string
Timestamp of when the system account was last updated.
createdAt String
Timestamp of when the system account was created.
id String
The provider-assigned unique ID for this managed resource.
updatedAt String
Timestamp of when the system account was last updated.
createdAt string
Timestamp of when the system account was created.
id string
The provider-assigned unique ID for this managed resource.
updatedAt string
Timestamp of when the system account was last updated.
created_at str
Timestamp of when the system account was created.
id str
The provider-assigned unique ID for this managed resource.
updated_at str
Timestamp of when the system account was last updated.
createdAt String
Timestamp of when the system account was created.
id String
The provider-assigned unique ID for this managed resource.
updatedAt String
Timestamp of when the system account was last updated.

Look up Existing SystemAccount Resource

Get an existing SystemAccount 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?: SystemAccountState, opts?: CustomResourceOptions): SystemAccount
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        konnect_managed: Optional[bool] = None,
        name: Optional[str] = None,
        updated_at: Optional[str] = None) -> SystemAccount
func GetSystemAccount(ctx *Context, name string, id IDInput, state *SystemAccountState, opts ...ResourceOption) (*SystemAccount, error)
public static SystemAccount Get(string name, Input<string> id, SystemAccountState? state, CustomResourceOptions? opts = null)
public static SystemAccount get(String name, Output<String> id, SystemAccountState state, CustomResourceOptions options)
resources:  _:    type: konnect:SystemAccount    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
CreatedAt string
Timestamp of when the system account was created.
Description string
Description of the system account. Useful when the system account name is not sufficient to differentiate one system account from another.
KonnectManaged bool
The system account is managed by Konnect (true/false). Requires replacement if changed.
Name string
Name of the system account.
UpdatedAt string
Timestamp of when the system account was last updated.
CreatedAt string
Timestamp of when the system account was created.
Description string
Description of the system account. Useful when the system account name is not sufficient to differentiate one system account from another.
KonnectManaged bool
The system account is managed by Konnect (true/false). Requires replacement if changed.
Name string
Name of the system account.
UpdatedAt string
Timestamp of when the system account was last updated.
createdAt String
Timestamp of when the system account was created.
description String
Description of the system account. Useful when the system account name is not sufficient to differentiate one system account from another.
konnectManaged Boolean
The system account is managed by Konnect (true/false). Requires replacement if changed.
name String
Name of the system account.
updatedAt String
Timestamp of when the system account was last updated.
createdAt string
Timestamp of when the system account was created.
description string
Description of the system account. Useful when the system account name is not sufficient to differentiate one system account from another.
konnectManaged boolean
The system account is managed by Konnect (true/false). Requires replacement if changed.
name string
Name of the system account.
updatedAt string
Timestamp of when the system account was last updated.
created_at str
Timestamp of when the system account was created.
description str
Description of the system account. Useful when the system account name is not sufficient to differentiate one system account from another.
konnect_managed bool
The system account is managed by Konnect (true/false). Requires replacement if changed.
name str
Name of the system account.
updated_at str
Timestamp of when the system account was last updated.
createdAt String
Timestamp of when the system account was created.
description String
Description of the system account. Useful when the system account name is not sufficient to differentiate one system account from another.
konnectManaged Boolean
The system account is managed by Konnect (true/false). Requires replacement if changed.
name String
Name of the system account.
updatedAt String
Timestamp of when the system account was last updated.

Import

$ pulumi import konnect:index/systemAccount:SystemAccount my_konnect_system_account ""
Copy

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

Package Details

Repository
konnect kong/terraform-provider-konnect
License
Notes
This Pulumi package is based on the konnect Terraform Provider.
konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect