Oracle Cloud Infrastructure

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

Certificate

This resource provides the Certificate resource in Oracle Cloud Infrastructure API Gateway service.

Creates a new Certificate.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testCertificate = new Oci.ApiGateway.Certificate("testCertificate", new Oci.ApiGateway.CertificateArgs
        {
            Certificate = @var.Certificate_certificate,
            CompartmentId = @var.Compartment_id,
            DefinedTags = 
            {
                { "Operations.CostCenter", "42" },
            },
            DisplayName = @var.Certificate_display_name,
            FreeformTags = 
            {
                { "Department", "Finance" },
            },
            IntermediateCertificates = @var.Certificate_intermediate_certificates,
            PrivateKey = @var.Certificate_private_key,
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ApiGateway.NewCertificate(ctx, "testCertificate", &ApiGateway.CertificateArgs{
			Certificate:   pulumi.Any(_var.Certificate_certificate),
			CompartmentId: pulumi.Any(_var.Compartment_id),
			DefinedTags: pulumi.AnyMap{
				"Operations.CostCenter": pulumi.Any("42"),
			},
			DisplayName: pulumi.Any(_var.Certificate_display_name),
			FreeformTags: pulumi.AnyMap{
				"Department": pulumi.Any("Finance"),
			},
			IntermediateCertificates: pulumi.Any(_var.Certificate_intermediate_certificates),
			PrivateKey:               pulumi.Any(_var.Certificate_private_key),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_certificate = oci.api_gateway.Certificate("testCertificate",
    certificate=var["certificate_certificate"],
    compartment_id=var["compartment_id"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=var["certificate_display_name"],
    freeform_tags={
        "Department": "Finance",
    },
    intermediate_certificates=var["certificate_intermediate_certificates"],
    private_key=var["certificate_private_key"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testCertificate = new oci.ApiGateway.Certificate("test_certificate", {
    //Required
    certificate: var_certificate_certificate,
    compartmentId: var_compartment_id,
    //Optional
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: var_certificate_display_name,
    freeformTags: {
        Department: "Finance",
    },
    intermediateCertificates: var_certificate_intermediate_certificates,
    privateKey: var_certificate_private_key,
});

Coming soon!

Create a Certificate Resource

new Certificate(name: string, args: CertificateArgs, opts?: CustomResourceOptions);
@overload
def Certificate(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                certificate: Optional[str] = None,
                compartment_id: Optional[str] = None,
                defined_tags: Optional[Mapping[str, Any]] = None,
                display_name: Optional[str] = None,
                freeform_tags: Optional[Mapping[str, Any]] = None,
                intermediate_certificates: Optional[str] = None,
                private_key: Optional[str] = None)
@overload
def Certificate(resource_name: str,
                args: CertificateArgs,
                opts: Optional[ResourceOptions] = None)
func NewCertificate(ctx *Context, name string, args CertificateArgs, opts ...ResourceOption) (*Certificate, error)
public Certificate(string name, CertificateArgs args, CustomResourceOptions? opts = null)
public Certificate(String name, CertificateArgs args)
public Certificate(String name, CertificateArgs args, CustomResourceOptions options)
type: oci:ApiGateway:Certificate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

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

CertificateDetails string

The data of the leaf certificate in pem format.

CompartmentId string

(Updatable) The OCID of the compartment in which the resource is created.

PrivateKey string

The private key associated with the certificate in pem format.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource

FreeformTags Dictionary<string, object>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

IntermediateCertificates string

The intermediate certificate data associated with the certificate in pem format.

Certificate string

The data of the leaf certificate in pem format.

CompartmentId string

(Updatable) The OCID of the compartment in which the resource is created.

PrivateKey string

The private key associated with the certificate in pem format.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource

FreeformTags map[string]interface{}

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

IntermediateCertificates string

The intermediate certificate data associated with the certificate in pem format.

certificate String

The data of the leaf certificate in pem format.

compartmentId String

(Updatable) The OCID of the compartment in which the resource is created.

privateKey String

The private key associated with the certificate in pem format.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource

freeformTags Map<String,Object>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

intermediateCertificates String

The intermediate certificate data associated with the certificate in pem format.

certificate string

The data of the leaf certificate in pem format.

compartmentId string

(Updatable) The OCID of the compartment in which the resource is created.

privateKey string

The private key associated with the certificate in pem format.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource

freeformTags {[key: string]: any}

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

intermediateCertificates string

The intermediate certificate data associated with the certificate in pem format.

certificate str

The data of the leaf certificate in pem format.

compartment_id str

(Updatable) The OCID of the compartment in which the resource is created.

private_key str

The private key associated with the certificate in pem format.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

display_name str

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource

freeform_tags Mapping[str, Any]

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

intermediate_certificates str

The intermediate certificate data associated with the certificate in pem format.

certificate String

The data of the leaf certificate in pem format.

compartmentId String

(Updatable) The OCID of the compartment in which the resource is created.

privateKey String

The private key associated with the certificate in pem format.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource

freeformTags Map<Any>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

intermediateCertificates String

The intermediate certificate data associated with the certificate in pem format.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

LifecycleDetails string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.

State string

The current state of the certificate.

SubjectNames List<string>

The entity to be secured by the certificate and additional host names.

TimeCreated string

The time this resource was created. An RFC3339 formatted datetime string.

TimeNotValidAfter string

The date and time the certificate will expire.

TimeUpdated string

The time this resource was last updated. An RFC3339 formatted datetime string.

Id string

The provider-assigned unique ID for this managed resource.

LifecycleDetails string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.

State string

The current state of the certificate.

SubjectNames []string

The entity to be secured by the certificate and additional host names.

TimeCreated string

The time this resource was created. An RFC3339 formatted datetime string.

TimeNotValidAfter string

The date and time the certificate will expire.

TimeUpdated string

The time this resource was last updated. An RFC3339 formatted datetime string.

id String

The provider-assigned unique ID for this managed resource.

lifecycleDetails String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.

state String

The current state of the certificate.

subjectNames List<String>

The entity to be secured by the certificate and additional host names.

timeCreated String

The time this resource was created. An RFC3339 formatted datetime string.

timeNotValidAfter String

The date and time the certificate will expire.

timeUpdated String

The time this resource was last updated. An RFC3339 formatted datetime string.

id string

The provider-assigned unique ID for this managed resource.

lifecycleDetails string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.

state string

The current state of the certificate.

subjectNames string[]

The entity to be secured by the certificate and additional host names.

timeCreated string

The time this resource was created. An RFC3339 formatted datetime string.

timeNotValidAfter string

The date and time the certificate will expire.

timeUpdated string

The time this resource was last updated. An RFC3339 formatted datetime string.

id str

The provider-assigned unique ID for this managed resource.

lifecycle_details str

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.

state str

The current state of the certificate.

subject_names Sequence[str]

The entity to be secured by the certificate and additional host names.

time_created str

The time this resource was created. An RFC3339 formatted datetime string.

time_not_valid_after str

The date and time the certificate will expire.

time_updated str

The time this resource was last updated. An RFC3339 formatted datetime string.

id String

The provider-assigned unique ID for this managed resource.

lifecycleDetails String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.

state String

The current state of the certificate.

subjectNames List<String>

The entity to be secured by the certificate and additional host names.

timeCreated String

The time this resource was created. An RFC3339 formatted datetime string.

timeNotValidAfter String

The date and time the certificate will expire.

timeUpdated String

The time this resource was last updated. An RFC3339 formatted datetime string.

Look up an Existing Certificate Resource

Get an existing Certificate 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?: CertificateState, opts?: CustomResourceOptions): Certificate
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        certificate: Optional[str] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        intermediate_certificates: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        private_key: Optional[str] = None,
        state: Optional[str] = None,
        subject_names: Optional[Sequence[str]] = None,
        time_created: Optional[str] = None,
        time_not_valid_after: Optional[str] = None,
        time_updated: Optional[str] = None) -> Certificate
func GetCertificate(ctx *Context, name string, id IDInput, state *CertificateState, opts ...ResourceOption) (*Certificate, error)
public static Certificate Get(string name, Input<string> id, CertificateState? state, CustomResourceOptions? opts = null)
public static Certificate get(String name, Output<String> id, CertificateState 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:
CertificateDetails string

The data of the leaf certificate in pem format.

CompartmentId string

(Updatable) The OCID of the compartment in which the resource is created.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource

FreeformTags Dictionary<string, object>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

IntermediateCertificates string

The intermediate certificate data associated with the certificate in pem format.

LifecycleDetails string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.

PrivateKey string

The private key associated with the certificate in pem format.

State string

The current state of the certificate.

SubjectNames List<string>

The entity to be secured by the certificate and additional host names.

TimeCreated string

The time this resource was created. An RFC3339 formatted datetime string.

TimeNotValidAfter string

The date and time the certificate will expire.

TimeUpdated string

The time this resource was last updated. An RFC3339 formatted datetime string.

Certificate string

The data of the leaf certificate in pem format.

CompartmentId string

(Updatable) The OCID of the compartment in which the resource is created.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource

FreeformTags map[string]interface{}

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

IntermediateCertificates string

The intermediate certificate data associated with the certificate in pem format.

LifecycleDetails string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.

PrivateKey string

The private key associated with the certificate in pem format.

State string

The current state of the certificate.

SubjectNames []string

The entity to be secured by the certificate and additional host names.

TimeCreated string

The time this resource was created. An RFC3339 formatted datetime string.

TimeNotValidAfter string

The date and time the certificate will expire.

TimeUpdated string

The time this resource was last updated. An RFC3339 formatted datetime string.

certificate String

The data of the leaf certificate in pem format.

compartmentId String

(Updatable) The OCID of the compartment in which the resource is created.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource

freeformTags Map<String,Object>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

intermediateCertificates String

The intermediate certificate data associated with the certificate in pem format.

lifecycleDetails String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.

privateKey String

The private key associated with the certificate in pem format.

state String

The current state of the certificate.

subjectNames List<String>

The entity to be secured by the certificate and additional host names.

timeCreated String

The time this resource was created. An RFC3339 formatted datetime string.

timeNotValidAfter String

The date and time the certificate will expire.

timeUpdated String

The time this resource was last updated. An RFC3339 formatted datetime string.

certificate string

The data of the leaf certificate in pem format.

compartmentId string

(Updatable) The OCID of the compartment in which the resource is created.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource

freeformTags {[key: string]: any}

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

intermediateCertificates string

The intermediate certificate data associated with the certificate in pem format.

lifecycleDetails string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.

privateKey string

The private key associated with the certificate in pem format.

state string

The current state of the certificate.

subjectNames string[]

The entity to be secured by the certificate and additional host names.

timeCreated string

The time this resource was created. An RFC3339 formatted datetime string.

timeNotValidAfter string

The date and time the certificate will expire.

timeUpdated string

The time this resource was last updated. An RFC3339 formatted datetime string.

certificate str

The data of the leaf certificate in pem format.

compartment_id str

(Updatable) The OCID of the compartment in which the resource is created.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

display_name str

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource

freeform_tags Mapping[str, Any]

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

intermediate_certificates str

The intermediate certificate data associated with the certificate in pem format.

lifecycle_details str

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.

private_key str

The private key associated with the certificate in pem format.

state str

The current state of the certificate.

subject_names Sequence[str]

The entity to be secured by the certificate and additional host names.

time_created str

The time this resource was created. An RFC3339 formatted datetime string.

time_not_valid_after str

The date and time the certificate will expire.

time_updated str

The time this resource was last updated. An RFC3339 formatted datetime string.

certificate String

The data of the leaf certificate in pem format.

compartmentId String

(Updatable) The OCID of the compartment in which the resource is created.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource

freeformTags Map<Any>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

intermediateCertificates String

The intermediate certificate data associated with the certificate in pem format.

lifecycleDetails String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.

privateKey String

The private key associated with the certificate in pem format.

state String

The current state of the certificate.

subjectNames List<String>

The entity to be secured by the certificate and additional host names.

timeCreated String

The time this resource was created. An RFC3339 formatted datetime string.

timeNotValidAfter String

The date and time the certificate will expire.

timeUpdated String

The time this resource was last updated. An RFC3339 formatted datetime string.

Import

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

 $ pulumi import oci:ApiGateway/certificate:Certificate test_certificate "id"

Package Details

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

This Pulumi package is based on the oci Terraform Provider.