1. Packages
  2. Packages
  3. Confluent Provider
  4. API Docs
  5. ServiceAccount
Viewing docs for Confluent v0.1.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-confluentcloud

confluentcloud.ServiceAccount

confluentcloud logo
Viewing docs for Confluent v0.1.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-confluentcloud

    Import

    You can import a Service Account by using Service Account ID, for example$ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>" $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"

     $ pulumi import confluentcloud:index/serviceAccount:ServiceAccount my_sa sa-abc123

    !> Warning: Do not forget to delete terminal command history afterwards for security purposes.

    Create ServiceAccount Resource

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

    Constructor syntax

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

@overload
def ServiceAccount(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   display_name: Optional[str] = None,
                   description: Optional[str] = None)
    func NewServiceAccount(ctx *Context, name string, args ServiceAccountArgs, opts ...ResourceOption) (*ServiceAccount, error)
    public ServiceAccount(string name, ServiceAccountArgs args, CustomResourceOptions? opts = null)
    public ServiceAccount(String name, ServiceAccountArgs args)
public ServiceAccount(String name, ServiceAccountArgs args, CustomResourceOptions options)

    type: confluentcloud:ServiceAccount
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 ServiceAccountArgs
    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 ServiceAccountArgs
    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 ServiceAccountArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceAccountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceAccountArgs
    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 serviceAccountResource = new ConfluentCloud.ServiceAccount("serviceAccountResource", new()
{
    DisplayName = "string",
    Description = "string",
});

    example, err := confluentcloud.NewServiceAccount(ctx, "serviceAccountResource", &confluentcloud.ServiceAccountArgs{
	DisplayName: pulumi.String("string"),
	Description: pulumi.String("string"),
})

    var serviceAccountResource = new ServiceAccount("serviceAccountResource", ServiceAccountArgs.builder()
    .displayName("string")
    .description("string")
    .build());

    service_account_resource = confluentcloud.ServiceAccount("serviceAccountResource",
    display_name="string",
    description="string")

    const serviceAccountResource = new confluentcloud.ServiceAccount("serviceAccountResource", {
    displayName: "string",
    description: "string",
});

    type: confluentcloud:ServiceAccount
properties:
    description: string
    displayName: string

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

    DisplayName string
    A human-readable name for the Service Account.
    Description string
    A free-form description of the Service Account.
    DisplayName string
    A human-readable name for the Service Account.
    Description string
    A free-form description of the Service Account.
    displayName String
    A human-readable name for the Service Account.
    description String
    A free-form description of the Service Account.
    displayName string
    A human-readable name for the Service Account.
    description string
    A free-form description of the Service Account.
    display_name str
    A human-readable name for the Service Account.
    description str
    A free-form description of the Service Account.
    displayName String
    A human-readable name for the Service Account.
    description String
    A free-form description of the Service Account.

    Outputs

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

    ApiVersion string
    (Required String) An API Version of the schema version of the Service Account, for example, iam/v2.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    (Required String) A kind of the Service Account, for example, ServiceAccount.
    ApiVersion string
    (Required String) An API Version of the schema version of the Service Account, for example, iam/v2.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    (Required String) A kind of the Service Account, for example, ServiceAccount.
    apiVersion String
    (Required String) An API Version of the schema version of the Service Account, for example, iam/v2.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    (Required String) A kind of the Service Account, for example, ServiceAccount.
    apiVersion string
    (Required String) An API Version of the schema version of the Service Account, for example, iam/v2.
    id string
    The provider-assigned unique ID for this managed resource.
    kind string
    (Required String) A kind of the Service Account, for example, ServiceAccount.
    api_version str
    (Required String) An API Version of the schema version of the Service Account, for example, iam/v2.
    id str
    The provider-assigned unique ID for this managed resource.
    kind str
    (Required String) A kind of the Service Account, for example, ServiceAccount.
    apiVersion String
    (Required String) An API Version of the schema version of the Service Account, for example, iam/v2.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    (Required String) A kind of the Service Account, for example, ServiceAccount.

    Look up Existing ServiceAccount Resource

    Get an existing ServiceAccount 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?: ServiceAccountState, opts?: CustomResourceOptions): ServiceAccount
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_version: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        kind: Optional[str] = None) -> ServiceAccount
    func GetServiceAccount(ctx *Context, name string, id IDInput, state *ServiceAccountState, opts ...ResourceOption) (*ServiceAccount, error)
    public static ServiceAccount Get(string name, Input<string> id, ServiceAccountState? state, CustomResourceOptions? opts = null)
    public static ServiceAccount get(String name, Output<String> id, ServiceAccountState state, CustomResourceOptions options)
    resources:  _:    type: confluentcloud:ServiceAccount    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:
    ApiVersion string
    (Required String) An API Version of the schema version of the Service Account, for example, iam/v2.
    Description string
    A free-form description of the Service Account.
    DisplayName string
    A human-readable name for the Service Account.
    Kind string
    (Required String) A kind of the Service Account, for example, ServiceAccount.
    ApiVersion string
    (Required String) An API Version of the schema version of the Service Account, for example, iam/v2.
    Description string
    A free-form description of the Service Account.
    DisplayName string
    A human-readable name for the Service Account.
    Kind string
    (Required String) A kind of the Service Account, for example, ServiceAccount.
    apiVersion String
    (Required String) An API Version of the schema version of the Service Account, for example, iam/v2.
    description String
    A free-form description of the Service Account.
    displayName String
    A human-readable name for the Service Account.
    kind String
    (Required String) A kind of the Service Account, for example, ServiceAccount.
    apiVersion string
    (Required String) An API Version of the schema version of the Service Account, for example, iam/v2.
    description string
    A free-form description of the Service Account.
    displayName string
    A human-readable name for the Service Account.
    kind string
    (Required String) A kind of the Service Account, for example, ServiceAccount.
    api_version str
    (Required String) An API Version of the schema version of the Service Account, for example, iam/v2.
    description str
    A free-form description of the Service Account.
    display_name str
    A human-readable name for the Service Account.
    kind str
    (Required String) A kind of the Service Account, for example, ServiceAccount.
    apiVersion String
    (Required String) An API Version of the schema version of the Service Account, for example, iam/v2.
    description String
    A free-form description of the Service Account.
    displayName String
    A human-readable name for the Service Account.
    kind String
    (Required String) A kind of the Service Account, for example, ServiceAccount.

    Package Details

    Repository
    Confluent Cloud pulumi/pulumi-confluentcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the confluent Terraform Provider.
    confluentcloud logo
    Viewing docs for Confluent v0.1.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-confluentcloud
      Try Pulumi Cloud free. Your team will thank you.