Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

CustomerSecretKey

This resource provides the Customer Secret Key resource in Oracle Cloud Infrastructure Identity service.

Creates a new secret key for the specified user. Secret keys are used for authentication with the Object Storage Service’s Amazon S3 compatible API. The secret key consists of an Access Key/Secret Key pair. For information, see Managing User Credentials.

You must specify a description for the secret key (although it can be an empty string). It does not have to be unique, and you can change it anytime with UpdateCustomerSecretKey.

Every user has permission to create a secret key for their own user ID. An administrator in your organization does not need to write a policy to give users this ability. To compare, administrators who have permission to the tenancy can use this operation to create a secret key for any user, including themselves.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testCustomerSecretKey = new Oci.Identity.CustomerSecretKey("testCustomerSecretKey", new Oci.Identity.CustomerSecretKeyArgs
        {
            DisplayName = @var.Customer_secret_key_display_name,
            UserId = oci_identity_user.Test_user.Id,
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/Identity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Identity.NewCustomerSecretKey(ctx, "testCustomerSecretKey", &Identity.CustomerSecretKeyArgs{
			DisplayName: pulumi.Any(_var.Customer_secret_key_display_name),
			UserId:      pulumi.Any(oci_identity_user.Test_user.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_customer_secret_key = oci.identity.CustomerSecretKey("testCustomerSecretKey",
    display_name=var["customer_secret_key_display_name"],
    user_id=oci_identity_user["test_user"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testCustomerSecretKey = new oci.identity.CustomerSecretKey("testCustomerSecretKey", {
    displayName: _var.customer_secret_key_display_name,
    userId: oci_identity_user.test_user.id,
});

Coming soon!

Create a CustomerSecretKey Resource

new CustomerSecretKey(name: string, args: CustomerSecretKeyArgs, opts?: CustomResourceOptions);
@overload
def CustomerSecretKey(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      display_name: Optional[str] = None,
                      user_id: Optional[str] = None)
@overload
def CustomerSecretKey(resource_name: str,
                      args: CustomerSecretKeyArgs,
                      opts: Optional[ResourceOptions] = None)
func NewCustomerSecretKey(ctx *Context, name string, args CustomerSecretKeyArgs, opts ...ResourceOption) (*CustomerSecretKey, error)
public CustomerSecretKey(string name, CustomerSecretKeyArgs args, CustomResourceOptions? opts = null)
public CustomerSecretKey(String name, CustomerSecretKeyArgs args)
public CustomerSecretKey(String name, CustomerSecretKeyArgs args, CustomResourceOptions options)
type: oci:Identity:CustomerSecretKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args CustomerSecretKeyArgs
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 CustomerSecretKeyArgs
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 CustomerSecretKeyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CustomerSecretKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args CustomerSecretKeyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

CustomerSecretKey Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The CustomerSecretKey resource accepts the following input properties:

DisplayName string

(Updatable) The name you assign to the secret key during creation. Does not have to be unique, and it's changeable.

UserId string

The OCID of the user.

DisplayName string

(Updatable) The name you assign to the secret key during creation. Does not have to be unique, and it's changeable.

UserId string

The OCID of the user.

displayName String

(Updatable) The name you assign to the secret key during creation. Does not have to be unique, and it's changeable.

userId String

The OCID of the user.

displayName string

(Updatable) The name you assign to the secret key during creation. Does not have to be unique, and it's changeable.

userId string

The OCID of the user.

display_name str

(Updatable) The name you assign to the secret key during creation. Does not have to be unique, and it's changeable.

user_id str

The OCID of the user.

displayName String

(Updatable) The name you assign to the secret key during creation. Does not have to be unique, and it's changeable.

userId String

The OCID of the user.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

InactiveState string

The detailed status of INACTIVE lifecycleState.

Key string

The secret key.

State string

The secret key's current state.

TimeCreated string

Date and time the CustomerSecretKey object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

TimeExpires string

Date and time when this password will expire, in the format defined by RFC3339. Null if it never expires. Example: 2016-08-25T21:10:29.600Z

Id string

The provider-assigned unique ID for this managed resource.

InactiveState string

The detailed status of INACTIVE lifecycleState.

Key string

The secret key.

State string

The secret key's current state.

TimeCreated string

Date and time the CustomerSecretKey object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

TimeExpires string

Date and time when this password will expire, in the format defined by RFC3339. Null if it never expires. Example: 2016-08-25T21:10:29.600Z

id String

The provider-assigned unique ID for this managed resource.

inactiveState String

The detailed status of INACTIVE lifecycleState.

key String

The secret key.

state String

The secret key's current state.

timeCreated String

Date and time the CustomerSecretKey object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

timeExpires String

Date and time when this password will expire, in the format defined by RFC3339. Null if it never expires. Example: 2016-08-25T21:10:29.600Z

id string

The provider-assigned unique ID for this managed resource.

inactiveState string

The detailed status of INACTIVE lifecycleState.

key string

The secret key.

state string

The secret key's current state.

timeCreated string

Date and time the CustomerSecretKey object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

timeExpires string

Date and time when this password will expire, in the format defined by RFC3339. Null if it never expires. Example: 2016-08-25T21:10:29.600Z

id str

The provider-assigned unique ID for this managed resource.

inactive_state str

The detailed status of INACTIVE lifecycleState.

key str

The secret key.

state str

The secret key's current state.

time_created str

Date and time the CustomerSecretKey object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

time_expires str

Date and time when this password will expire, in the format defined by RFC3339. Null if it never expires. Example: 2016-08-25T21:10:29.600Z

id String

The provider-assigned unique ID for this managed resource.

inactiveState String

The detailed status of INACTIVE lifecycleState.

key String

The secret key.

state String

The secret key's current state.

timeCreated String

Date and time the CustomerSecretKey object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

timeExpires String

Date and time when this password will expire, in the format defined by RFC3339. Null if it never expires. Example: 2016-08-25T21:10:29.600Z

Look up an Existing CustomerSecretKey Resource

Get an existing CustomerSecretKey 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?: CustomerSecretKeyState, opts?: CustomResourceOptions): CustomerSecretKey
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        display_name: Optional[str] = None,
        inactive_state: Optional[str] = None,
        key: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        time_expires: Optional[str] = None,
        user_id: Optional[str] = None) -> CustomerSecretKey
func GetCustomerSecretKey(ctx *Context, name string, id IDInput, state *CustomerSecretKeyState, opts ...ResourceOption) (*CustomerSecretKey, error)
public static CustomerSecretKey Get(string name, Input<string> id, CustomerSecretKeyState? state, CustomResourceOptions? opts = null)
public static CustomerSecretKey get(String name, Output<String> id, CustomerSecretKeyState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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:
DisplayName string

(Updatable) The name you assign to the secret key during creation. Does not have to be unique, and it's changeable.

InactiveState string

The detailed status of INACTIVE lifecycleState.

Key string

The secret key.

State string

The secret key's current state.

TimeCreated string

Date and time the CustomerSecretKey object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

TimeExpires string

Date and time when this password will expire, in the format defined by RFC3339. Null if it never expires. Example: 2016-08-25T21:10:29.600Z

UserId string

The OCID of the user.

DisplayName string

(Updatable) The name you assign to the secret key during creation. Does not have to be unique, and it's changeable.

InactiveState string

The detailed status of INACTIVE lifecycleState.

Key string

The secret key.

State string

The secret key's current state.

TimeCreated string

Date and time the CustomerSecretKey object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

TimeExpires string

Date and time when this password will expire, in the format defined by RFC3339. Null if it never expires. Example: 2016-08-25T21:10:29.600Z

UserId string

The OCID of the user.

displayName String

(Updatable) The name you assign to the secret key during creation. Does not have to be unique, and it's changeable.

inactiveState String

The detailed status of INACTIVE lifecycleState.

key String

The secret key.

state String

The secret key's current state.

timeCreated String

Date and time the CustomerSecretKey object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

timeExpires String

Date and time when this password will expire, in the format defined by RFC3339. Null if it never expires. Example: 2016-08-25T21:10:29.600Z

userId String

The OCID of the user.

displayName string

(Updatable) The name you assign to the secret key during creation. Does not have to be unique, and it's changeable.

inactiveState string

The detailed status of INACTIVE lifecycleState.

key string

The secret key.

state string

The secret key's current state.

timeCreated string

Date and time the CustomerSecretKey object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

timeExpires string

Date and time when this password will expire, in the format defined by RFC3339. Null if it never expires. Example: 2016-08-25T21:10:29.600Z

userId string

The OCID of the user.

display_name str

(Updatable) The name you assign to the secret key during creation. Does not have to be unique, and it's changeable.

inactive_state str

The detailed status of INACTIVE lifecycleState.

key str

The secret key.

state str

The secret key's current state.

time_created str

Date and time the CustomerSecretKey object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

time_expires str

Date and time when this password will expire, in the format defined by RFC3339. Null if it never expires. Example: 2016-08-25T21:10:29.600Z

user_id str

The OCID of the user.

displayName String

(Updatable) The name you assign to the secret key during creation. Does not have to be unique, and it's changeable.

inactiveState String

The detailed status of INACTIVE lifecycleState.

key String

The secret key.

state String

The secret key's current state.

timeCreated String

Date and time the CustomerSecretKey object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

timeExpires String

Date and time when this password will expire, in the format defined by RFC3339. Null if it never expires. Example: 2016-08-25T21:10:29.600Z

userId String

The OCID of the user.

Import

CustomerSecretKeys can be imported using the id, e.g.

 $ pulumi import oci:Identity/customerSecretKey:CustomerSecretKey test_customer_secret_key "users/{userId}/customerSecretKeys/{customerSecretKeyId}"

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.