oci.ApiGateway.getCertificates
Explore with Pulumi AI
This data source provides the list of Certificates in Oracle Cloud Infrastructure API Gateway service.
Returns a list of certificates.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testCertificates = Oci.ApiGateway.GetCertificates.Invoke(new()
{
CompartmentId = @var.Compartment_id,
DisplayName = @var.Certificate_display_name,
State = @var.Certificate_state,
});
});
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.GetCertificates(ctx, &apigateway.GetCertificatesArgs{
CompartmentId: _var.Compartment_id,
DisplayName: pulumi.StringRef(_var.Certificate_display_name),
State: pulumi.StringRef(_var.Certificate_state),
}, nil)
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ApiGateway.ApiGatewayFunctions;
import com.pulumi.oci.ApiGateway.inputs.GetCertificatesArgs;
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) {
final var testCertificates = ApiGatewayFunctions.getCertificates(GetCertificatesArgs.builder()
.compartmentId(var_.compartment_id())
.displayName(var_.certificate_display_name())
.state(var_.certificate_state())
.build());
}
}
import pulumi
import pulumi_oci as oci
test_certificates = oci.ApiGateway.get_certificates(compartment_id=var["compartment_id"],
display_name=var["certificate_display_name"],
state=var["certificate_state"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testCertificates = oci.ApiGateway.getCertificates({
compartmentId: _var.compartment_id,
displayName: _var.certificate_display_name,
state: _var.certificate_state,
});
variables:
testCertificates:
fn::invoke:
Function: oci:ApiGateway:getCertificates
Arguments:
compartmentId: ${var.compartment_id}
displayName: ${var.certificate_display_name}
state: ${var.certificate_state}
Using getCertificates
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getCertificates(args: GetCertificatesArgs, opts?: InvokeOptions): Promise<GetCertificatesResult>
function getCertificatesOutput(args: GetCertificatesOutputArgs, opts?: InvokeOptions): Output<GetCertificatesResult>
def get_certificates(compartment_id: Optional[str] = None,
display_name: Optional[str] = None,
filters: Optional[Sequence[_apigateway.GetCertificatesFilter]] = None,
state: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetCertificatesResult
def get_certificates_output(compartment_id: Optional[pulumi.Input[str]] = None,
display_name: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[_apigateway.GetCertificatesFilterArgs]]]] = None,
state: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetCertificatesResult]
func GetCertificates(ctx *Context, args *GetCertificatesArgs, opts ...InvokeOption) (*GetCertificatesResult, error)
func GetCertificatesOutput(ctx *Context, args *GetCertificatesOutputArgs, opts ...InvokeOption) GetCertificatesResultOutput
> Note: This function is named GetCertificates
in the Go SDK.
public static class GetCertificates
{
public static Task<GetCertificatesResult> InvokeAsync(GetCertificatesArgs args, InvokeOptions? opts = null)
public static Output<GetCertificatesResult> Invoke(GetCertificatesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCertificatesResult> getCertificates(GetCertificatesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:ApiGateway/getCertificates:getCertificates
arguments:
# arguments dictionary
The following arguments are supported:
- Compartment
Id string The ocid of the compartment in which to list resources.
- Display
Name string A user-friendly name. Does not have to be unique, and it's changeable. Example:
My new resource
- Filters
List<Get
Certificates Filter> - State string
A filter to return only resources that match the given lifecycle state. Example:
ACTIVE
orDELETED
- Compartment
Id string The ocid of the compartment in which to list resources.
- Display
Name string A user-friendly name. Does not have to be unique, and it's changeable. Example:
My new resource
- Filters
[]Get
Certificates Filter - State string
A filter to return only resources that match the given lifecycle state. Example:
ACTIVE
orDELETED
- compartment
Id String The ocid of the compartment in which to list resources.
- display
Name String A user-friendly name. Does not have to be unique, and it's changeable. Example:
My new resource
- filters
List<Get
Certificates Filter> - state String
A filter to return only resources that match the given lifecycle state. Example:
ACTIVE
orDELETED
- compartment
Id string The ocid of the compartment in which to list resources.
- display
Name string A user-friendly name. Does not have to be unique, and it's changeable. Example:
My new resource
- filters
Get
Certificates Filter[] - state string
A filter to return only resources that match the given lifecycle state. Example:
ACTIVE
orDELETED
- compartment_
id str The ocid of the compartment in which to list resources.
- display_
name str A user-friendly name. Does not have to be unique, and it's changeable. Example:
My new resource
- filters
Get
Certificates Filter] - state str
A filter to return only resources that match the given lifecycle state. Example:
ACTIVE
orDELETED
- compartment
Id String The ocid of the compartment in which to list resources.
- display
Name String A user-friendly name. Does not have to be unique, and it's changeable. Example:
My new resource
- filters List<Property Map>
- state String
A filter to return only resources that match the given lifecycle state. Example:
ACTIVE
orDELETED
getCertificates Result
The following output properties are available:
- Certificate
Collections List<GetCertificates Certificate Collection> The list of certificate_collection.
- Compartment
Id string The OCID of the compartment in which the resource is created.
- Id string
The provider-assigned unique ID for this managed resource.
- Display
Name string A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- Filters
List<Get
Certificates Filter> - State string
The current state of the certificate.
- Certificate
Collections []GetCertificates Certificate Collection The list of certificate_collection.
- Compartment
Id string The OCID of the compartment in which the resource is created.
- Id string
The provider-assigned unique ID for this managed resource.
- Display
Name string A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- Filters
[]Get
Certificates Filter - State string
The current state of the certificate.
- certificate
Collections List<GetCertificates Certificate Collection> The list of certificate_collection.
- compartment
Id String The OCID of the compartment in which the resource is created.
- id String
The provider-assigned unique ID for this managed resource.
- display
Name String A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- filters
List<Get
Certificates Filter> - state String
The current state of the certificate.
- certificate
Collections GetCertificates Certificate Collection[] The list of certificate_collection.
- compartment
Id string The OCID of the compartment in which the resource is created.
- id string
The provider-assigned unique ID for this managed resource.
- display
Name string A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- filters
Get
Certificates Filter[] - state string
The current state of the certificate.
- certificate_
collections GetCertificates Certificate Collection] The list of certificate_collection.
- compartment_
id str The OCID of the compartment in which the resource is created.
- id str
The provider-assigned unique ID for this managed resource.
- display_
name str A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- filters
Get
Certificates Filter] - state str
The current state of the certificate.
- certificate
Collections List<Property Map> The list of certificate_collection.
- compartment
Id String The OCID of the compartment in which the resource is created.
- id String
The provider-assigned unique ID for this managed resource.
- display
Name String A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- filters List<Property Map>
- state String
The current state of the certificate.
Supporting Types
GetCertificatesCertificateCollection
GetCertificatesCertificateCollectionItem
- Certificate string
The data of the leaf certificate in pem format.
- Compartment
Id string The ocid of the compartment in which to list resources.
- Dictionary<string, object>
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 string A user-friendly name. Does not have to be unique, and it's changeable. Example:
My new resource
- Dictionary<string, object>
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"}
- Id string
The OCID of the resource.
- Intermediate
Certificates string The intermediate certificate data associated with the certificate in pem format.
- Lifecycle
Details 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.
- Private
Key string - State string
A filter to return only resources that match the given lifecycle state. Example:
ACTIVE
orDELETED
- Subject
Names List<string> The entity to be secured by the certificate and additional host names.
- Time
Created string The time this resource was created. An RFC3339 formatted datetime string.
- Time
Not stringValid After The date and time the certificate will expire.
- Time
Updated string The time this resource was last updated. An RFC3339 formatted datetime string.
- Certificate string
The data of the leaf certificate in pem format.
- Compartment
Id string The ocid of the compartment in which to list resources.
- map[string]interface{}
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 string A user-friendly name. Does not have to be unique, and it's changeable. Example:
My new resource
- map[string]interface{}
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"}
- Id string
The OCID of the resource.
- Intermediate
Certificates string The intermediate certificate data associated with the certificate in pem format.
- Lifecycle
Details 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.
- Private
Key string - State string
A filter to return only resources that match the given lifecycle state. Example:
ACTIVE
orDELETED
- Subject
Names []string The entity to be secured by the certificate and additional host names.
- Time
Created string The time this resource was created. An RFC3339 formatted datetime string.
- Time
Not stringValid After The date and time the certificate will expire.
- Time
Updated string The time this resource was last updated. An RFC3339 formatted datetime string.
- certificate String
The data of the leaf certificate in pem format.
- compartment
Id String The ocid of the compartment in which to list resources.
- Map<String,Object>
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 String A user-friendly name. Does not have to be unique, and it's changeable. Example:
My new resource
- Map<String,Object>
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"}
- id String
The OCID of the resource.
- intermediate
Certificates String The intermediate certificate data associated with the certificate in pem format.
- lifecycle
Details 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.
- private
Key String - state String
A filter to return only resources that match the given lifecycle state. Example:
ACTIVE
orDELETED
- subject
Names List<String> The entity to be secured by the certificate and additional host names.
- time
Created String The time this resource was created. An RFC3339 formatted datetime string.
- time
Not StringValid After The date and time the certificate will expire.
- time
Updated String The time this resource was last updated. An RFC3339 formatted datetime string.
- certificate string
The data of the leaf certificate in pem format.
- compartment
Id string The ocid of the compartment in which to list resources.
- {[key: string]: any}
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 string A user-friendly name. Does not have to be unique, and it's changeable. Example:
My new resource
- {[key: string]: any}
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"}
- id string
The OCID of the resource.
- intermediate
Certificates string The intermediate certificate data associated with the certificate in pem format.
- lifecycle
Details 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.
- private
Key string - state string
A filter to return only resources that match the given lifecycle state. Example:
ACTIVE
orDELETED
- subject
Names string[] The entity to be secured by the certificate and additional host names.
- time
Created string The time this resource was created. An RFC3339 formatted datetime string.
- time
Not stringValid After The date and time the certificate will expire.
- time
Updated 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 The ocid of the compartment in which to list resources.
- Mapping[str, Any]
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 A user-friendly name. Does not have to be unique, and it's changeable. Example:
My new resource
- Mapping[str, Any]
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"}
- id str
The OCID of the resource.
- 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 - state str
A filter to return only resources that match the given lifecycle state. Example:
ACTIVE
orDELETED
- 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_ strvalid_ after 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.
- compartment
Id String The ocid of the compartment in which to list resources.
- Map<Any>
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 String A user-friendly name. Does not have to be unique, and it's changeable. Example:
My new resource
- Map<Any>
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"}
- id String
The OCID of the resource.
- intermediate
Certificates String The intermediate certificate data associated with the certificate in pem format.
- lifecycle
Details 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.
- private
Key String - state String
A filter to return only resources that match the given lifecycle state. Example:
ACTIVE
orDELETED
- subject
Names List<String> The entity to be secured by the certificate and additional host names.
- time
Created String The time this resource was created. An RFC3339 formatted datetime string.
- time
Not StringValid After The date and time the certificate will expire.
- time
Updated String The time this resource was last updated. An RFC3339 formatted datetime string.
GetCertificatesFilter
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.