1. Packages
  2. Control Plane (cpln)
  3. API Docs
  4. ServiceAccountKey
Control Plane v0.0.56 published on Wednesday, Apr 9, 2025 by pulumiverse

cpln.ServiceAccountKey

Explore with Pulumi AI

Create ServiceAccountKey Resource

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

Constructor syntax

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

@overload
def ServiceAccountKey(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      description: Optional[str] = None,
                      service_account_name: Optional[str] = None)
func NewServiceAccountKey(ctx *Context, name string, args ServiceAccountKeyArgs, opts ...ResourceOption) (*ServiceAccountKey, error)
public ServiceAccountKey(string name, ServiceAccountKeyArgs args, CustomResourceOptions? opts = null)
public ServiceAccountKey(String name, ServiceAccountKeyArgs args)
public ServiceAccountKey(String name, ServiceAccountKeyArgs args, CustomResourceOptions options)
type: cpln:ServiceAccountKey
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. ServiceAccountKeyArgs
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. ServiceAccountKeyArgs
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. ServiceAccountKeyArgs
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. ServiceAccountKeyArgs
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. ServiceAccountKeyArgs
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 serviceAccountKeyResource = new Cpln.ServiceAccountKey("serviceAccountKeyResource", new()
{
    Description = "string",
    ServiceAccountName = "string",
});
Copy
example, err := cpln.NewServiceAccountKey(ctx, "serviceAccountKeyResource", &cpln.ServiceAccountKeyArgs{
	Description:        pulumi.String("string"),
	ServiceAccountName: pulumi.String("string"),
})
Copy
var serviceAccountKeyResource = new ServiceAccountKey("serviceAccountKeyResource", ServiceAccountKeyArgs.builder()
    .description("string")
    .serviceAccountName("string")
    .build());
Copy
service_account_key_resource = cpln.ServiceAccountKey("serviceAccountKeyResource",
    description="string",
    service_account_name="string")
Copy
const serviceAccountKeyResource = new cpln.ServiceAccountKey("serviceAccountKeyResource", {
    description: "string",
    serviceAccountName: "string",
});
Copy
type: cpln:ServiceAccountKey
properties:
    description: string
    serviceAccountName: string
Copy

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

Description
This property is required.
Changes to this property will trigger replacement.
string
Description of the Service Account Key.
ServiceAccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of an existing Service Account this key will belong to.
Description
This property is required.
Changes to this property will trigger replacement.
string
Description of the Service Account Key.
ServiceAccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of an existing Service Account this key will belong to.
description
This property is required.
Changes to this property will trigger replacement.
String
Description of the Service Account Key.
serviceAccountName
This property is required.
Changes to this property will trigger replacement.
String
The name of an existing Service Account this key will belong to.
description
This property is required.
Changes to this property will trigger replacement.
string
Description of the Service Account Key.
serviceAccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of an existing Service Account this key will belong to.
description
This property is required.
Changes to this property will trigger replacement.
str
Description of the Service Account Key.
service_account_name
This property is required.
Changes to this property will trigger replacement.
str
The name of an existing Service Account this key will belong to.
description
This property is required.
Changes to this property will trigger replacement.
String
Description of the Service Account Key.
serviceAccountName
This property is required.
Changes to this property will trigger replacement.
String
The name of an existing Service Account this key will belong to.

Outputs

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

Created string
The timestamp, in UTC, when the key was created.
Id string
The provider-assigned unique ID for this managed resource.
Key string
The generated key.
Name string
The generated name of the key.
Created string
The timestamp, in UTC, when the key was created.
Id string
The provider-assigned unique ID for this managed resource.
Key string
The generated key.
Name string
The generated name of the key.
created String
The timestamp, in UTC, when the key was created.
id String
The provider-assigned unique ID for this managed resource.
key String
The generated key.
name String
The generated name of the key.
created string
The timestamp, in UTC, when the key was created.
id string
The provider-assigned unique ID for this managed resource.
key string
The generated key.
name string
The generated name of the key.
created str
The timestamp, in UTC, when the key was created.
id str
The provider-assigned unique ID for this managed resource.
key str
The generated key.
name str
The generated name of the key.
created String
The timestamp, in UTC, when the key was created.
id String
The provider-assigned unique ID for this managed resource.
key String
The generated key.
name String
The generated name of the key.

Look up Existing ServiceAccountKey Resource

Get an existing ServiceAccountKey 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?: ServiceAccountKeyState, opts?: CustomResourceOptions): ServiceAccountKey
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created: Optional[str] = None,
        description: Optional[str] = None,
        key: Optional[str] = None,
        name: Optional[str] = None,
        service_account_name: Optional[str] = None) -> ServiceAccountKey
func GetServiceAccountKey(ctx *Context, name string, id IDInput, state *ServiceAccountKeyState, opts ...ResourceOption) (*ServiceAccountKey, error)
public static ServiceAccountKey Get(string name, Input<string> id, ServiceAccountKeyState? state, CustomResourceOptions? opts = null)
public static ServiceAccountKey get(String name, Output<String> id, ServiceAccountKeyState state, CustomResourceOptions options)
resources:  _:    type: cpln:ServiceAccountKey    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:
Created string
The timestamp, in UTC, when the key was created.
Description Changes to this property will trigger replacement. string
Description of the Service Account Key.
Key string
The generated key.
Name string
The generated name of the key.
ServiceAccountName Changes to this property will trigger replacement. string
The name of an existing Service Account this key will belong to.
Created string
The timestamp, in UTC, when the key was created.
Description Changes to this property will trigger replacement. string
Description of the Service Account Key.
Key string
The generated key.
Name string
The generated name of the key.
ServiceAccountName Changes to this property will trigger replacement. string
The name of an existing Service Account this key will belong to.
created String
The timestamp, in UTC, when the key was created.
description Changes to this property will trigger replacement. String
Description of the Service Account Key.
key String
The generated key.
name String
The generated name of the key.
serviceAccountName Changes to this property will trigger replacement. String
The name of an existing Service Account this key will belong to.
created string
The timestamp, in UTC, when the key was created.
description Changes to this property will trigger replacement. string
Description of the Service Account Key.
key string
The generated key.
name string
The generated name of the key.
serviceAccountName Changes to this property will trigger replacement. string
The name of an existing Service Account this key will belong to.
created str
The timestamp, in UTC, when the key was created.
description Changes to this property will trigger replacement. str
Description of the Service Account Key.
key str
The generated key.
name str
The generated name of the key.
service_account_name Changes to this property will trigger replacement. str
The name of an existing Service Account this key will belong to.
created String
The timestamp, in UTC, when the key was created.
description Changes to this property will trigger replacement. String
Description of the Service Account Key.
key String
The generated key.
name String
The generated name of the key.
serviceAccountName Changes to this property will trigger replacement. String
The name of an existing Service Account this key will belong to.

Package Details

Repository
cpln pulumiverse/pulumi-cpln
License
Apache-2.0
Notes
This Pulumi package is based on the cpln Terraform Provider.