import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Api resource in Oracle Cloud Infrastructure API Gateway service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/api-gateway/latest/Api * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/api_gateway * * Creates a new API. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testApi = new oci.apigateway.Api("test_api", { * compartmentId: compartmentId, * content: apiContent, * definedTags: { * "Operations.CostCenter": "42", * }, * displayName: apiDisplayName, * freeformTags: { * Department: "Finance", * }, * locks: [{ * type: apiLocksType, * message: apiLocksMessage, * }], * }); * ``` * * ## Import * * Apis can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:ApiGateway/api:Api test_api "id" * ``` */ export declare class Api extends pulumi.CustomResource { /** * Get an existing Api resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: ApiState, opts?: pulumi.CustomResourceOptions): Api; /** * Returns true if the given object is an instance of Api. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Api; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created. */ readonly compartmentId: pulumi.Output; /** * (Updatable) API Specification content in json or yaml format */ readonly content: pulumi.Output; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ readonly displayName: pulumi.Output; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: string; }>; readonly isLockOverride: pulumi.Output; /** * A message describing the current lifecycleState in more detail. For ACTIVE state it describes if the document has been validated and the possible values are: * * 'New' for just updated API Specifications * * 'Validating' for a document which is being validated. * * 'Valid' the document has been validated without any errors or warnings * * 'Warning' the document has been validated and contains warnings * * 'Error' the document has been validated and contains errors * * 'Failed' the document validation failed * * 'Canceled' the document validation was canceled */ readonly lifecycleDetails: pulumi.Output; /** * Locks associated with this resource. */ readonly locks: pulumi.Output; /** * Type of API Specification file. */ readonly specificationType: pulumi.Output; /** * The current state of the API. */ readonly state: pulumi.Output; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ readonly systemTags: pulumi.Output<{ [key: string]: string; }>; /** * The time this resource was created. An RFC3339 formatted datetime string. */ readonly timeCreated: pulumi.Output; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ readonly timeUpdated: pulumi.Output; /** * Status of each feature available from the API. */ readonly validationResults: pulumi.Output; /** * Create a Api resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: ApiArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Api resources. */ export interface ApiState { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created. */ compartmentId?: pulumi.Input; /** * (Updatable) API Specification content in json or yaml format */ content?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName?: pulumi.Input; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; isLockOverride?: pulumi.Input; /** * A message describing the current lifecycleState in more detail. For ACTIVE state it describes if the document has been validated and the possible values are: * * 'New' for just updated API Specifications * * 'Validating' for a document which is being validated. * * 'Valid' the document has been validated without any errors or warnings * * 'Warning' the document has been validated and contains warnings * * 'Error' the document has been validated and contains errors * * 'Failed' the document validation failed * * 'Canceled' the document validation was canceled */ lifecycleDetails?: pulumi.Input; /** * Locks associated with this resource. */ locks?: pulumi.Input[] | undefined>; /** * Type of API Specification file. */ specificationType?: pulumi.Input; /** * The current state of the API. */ state?: pulumi.Input; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated?: pulumi.Input; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated?: pulumi.Input; /** * Status of each feature available from the API. */ validationResults?: pulumi.Input[] | undefined>; } /** * The set of arguments for constructing a Api resource. */ export interface ApiArgs { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created. */ compartmentId: pulumi.Input; /** * (Updatable) API Specification content in json or yaml format */ content?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName?: pulumi.Input; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; isLockOverride?: pulumi.Input; /** * Locks associated with this resource. */ locks?: pulumi.Input[] | undefined>; } //# sourceMappingURL=api.d.ts.map