Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ApiGateway
  5. Api
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

oci.ApiGateway.Api

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

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

    Creates a new API.

    Example Usage

    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",
    },
});

    import pulumi
import pulumi_oci as oci

test_api = oci.api_gateway.Api("test_api",
    compartment_id=compartment_id,
    content=api_content,
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=api_display_name,
    freeform_tags={
        "Department": "Finance",
    })

    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.NewApi(ctx, "test_api", &ApiGateway.ApiArgs{
			CompartmentId: pulumi.Any(compartmentId),
			Content:       pulumi.Any(apiContent),
			DefinedTags: pulumi.Map{
				"Operations.CostCenter": pulumi.Any("42"),
			},
			DisplayName: pulumi.Any(apiDisplayName),
			FreeformTags: pulumi.Map{
				"Department": pulumi.Any("Finance"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testApi = new Oci.ApiGateway.Api("test_api", new()
    {
        CompartmentId = compartmentId,
        Content = apiContent,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = apiDisplayName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ApiGateway.Api;
import com.pulumi.oci.ApiGateway.ApiArgs;
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) {
        var testApi = new Api("testApi", ApiArgs.builder()
            .compartmentId(compartmentId)
            .content(apiContent)
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(apiDisplayName)
            .freeformTags(Map.of("Department", "Finance"))
            .build());

    }
}

    resources:
  testApi:
    type: oci:ApiGateway:Api
    name: test_api
    properties:
      compartmentId: ${compartmentId}
      content: ${apiContent}
      definedTags:
        Operations.CostCenter: '42'
      displayName: ${apiDisplayName}
      freeformTags:
        Department: Finance

    Create Api Resource

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

    Constructor syntax

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

@overload
def Api(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        content: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None)
    func NewApi(ctx *Context, name string, args ApiArgs, opts ...ResourceOption) (*Api, error)
    public Api(string name, ApiArgs args, CustomResourceOptions? opts = null)
    public Api(String name, ApiArgs args)
public Api(String name, ApiArgs args, CustomResourceOptions options)

    type: oci:ApiGateway:Api
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ApiArgs
    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 ApiArgs
    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 ApiArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiArgs
    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 apiResource = new Oci.ApiGateway.Api("apiResource", new()
{
    CompartmentId = "string",
    Content = "string",
    DefinedTags = 
    {
        { "string", "any" },
    },
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "any" },
    },
});

    example, err := ApiGateway.NewApi(ctx, "apiResource", &ApiGateway.ApiArgs{
	CompartmentId: pulumi.String("string"),
	Content:       pulumi.String("string"),
	DefinedTags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
})

    var apiResource = new Api("apiResource", ApiArgs.builder()
    .compartmentId("string")
    .content("string")
    .definedTags(Map.of("string", "any"))
    .displayName("string")
    .freeformTags(Map.of("string", "any"))
    .build());

    api_resource = oci.api_gateway.Api("apiResource",
    compartment_id="string",
    content="string",
    defined_tags={
        "string": "any",
    },
    display_name="string",
    freeform_tags={
        "string": "any",
    })

    const apiResource = new oci.apigateway.Api("apiResource", {
    compartmentId: "string",
    content: "string",
    definedTags: {
        string: "any",
    },
    displayName: "string",
    freeformTags: {
        string: "any",
    },
});

    type: oci:ApiGateway:Api
properties:
    compartmentId: string
    content: string
    definedTags:
        string: any
    displayName: string
    freeformTags:
        string: any

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

    CompartmentId string
    (Updatable) The OCID of the compartment in which the resource is created.
    Content string
    (Updatable) API Specification content in json or yaml 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"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    CompartmentId string
    (Updatable) The OCID of the compartment in which the resource is created.
    Content string
    (Updatable) API Specification content in json or yaml 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"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    (Updatable) The OCID of the compartment in which the resource is created.
    content String
    (Updatable) API Specification content in json or yaml 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"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId string
    (Updatable) The OCID of the compartment in which the resource is created.
    content string
    (Updatable) API Specification content in json or yaml 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"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartment_id str
    (Updatable) The OCID of the compartment in which the resource is created.
    content str
    (Updatable) API Specification content in json or yaml 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"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    (Updatable) The OCID of the compartment in which the resource is created.
    content String
    (Updatable) API Specification content in json or yaml 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"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    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
    SpecificationType string
    Type of API Specification file.
    State string
    The current state of the API.
    TimeCreated string
    The time this resource was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time this resource was last updated. An RFC3339 formatted datetime string.
    ValidationResults List<ApiValidationResult>
    Status of each feature available from the API.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    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
    SpecificationType string
    Type of API Specification file.
    State string
    The current state of the API.
    TimeCreated string
    The time this resource was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time this resource was last updated. An RFC3339 formatted datetime string.
    ValidationResults []ApiValidationResult
    Status of each feature available from the API.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    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
    specificationType String
    Type of API Specification file.
    state String
    The current state of the API.
    timeCreated String
    The time this resource was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time this resource was last updated. An RFC3339 formatted datetime string.
    validationResults List<ApiValidationResult>
    Status of each feature available from the API.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    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
    specificationType string
    Type of API Specification file.
    state string
    The current state of the API.
    timeCreated string
    The time this resource was created. An RFC3339 formatted datetime string.
    timeUpdated string
    The time this resource was last updated. An RFC3339 formatted datetime string.
    validationResults ApiValidationResult[]
    Status of each feature available from the API.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    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
    specification_type str
    Type of API Specification file.
    state str
    The current state of the API.
    time_created str
    The time this resource was created. An RFC3339 formatted datetime string.
    time_updated str
    The time this resource was last updated. An RFC3339 formatted datetime string.
    validation_results Sequence[apigateway.ApiValidationResult]
    Status of each feature available from the API.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    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
    specificationType String
    Type of API Specification file.
    state String
    The current state of the API.
    timeCreated String
    The time this resource was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time this resource was last updated. An RFC3339 formatted datetime string.
    validationResults List<Property Map>
    Status of each feature available from the API.

    Look up Existing Api Resource

    Get an existing Api 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?: ApiState, opts?: CustomResourceOptions): Api
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        content: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        lifecycle_details: Optional[str] = None,
        specification_type: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        validation_results: Optional[Sequence[_apigateway.ApiValidationResultArgs]] = None) -> Api
    func GetApi(ctx *Context, name string, id IDInput, state *ApiState, opts ...ResourceOption) (*Api, error)
    public static Api Get(string name, Input<string> id, ApiState? state, CustomResourceOptions? opts = null)
    public static Api get(String name, Output<String> id, ApiState 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:
    CompartmentId string
    (Updatable) The OCID of the compartment in which the resource is created.
    Content string
    (Updatable) API Specification content in json or yaml 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"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    LifecycleDetails string
    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
    SpecificationType string
    Type of API Specification file.
    State string
    The current state of the API.
    TimeCreated string
    The time this resource was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time this resource was last updated. An RFC3339 formatted datetime string.
    ValidationResults List<ApiValidationResult>
    Status of each feature available from the API.
    CompartmentId string
    (Updatable) The OCID of the compartment in which the resource is created.
    Content string
    (Updatable) API Specification content in json or yaml 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"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    LifecycleDetails string
    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
    SpecificationType string
    Type of API Specification file.
    State string
    The current state of the API.
    TimeCreated string
    The time this resource was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time this resource was last updated. An RFC3339 formatted datetime string.
    ValidationResults []ApiValidationResultArgs
    Status of each feature available from the API.
    compartmentId String
    (Updatable) The OCID of the compartment in which the resource is created.
    content String
    (Updatable) API Specification content in json or yaml 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"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    lifecycleDetails String
    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
    specificationType String
    Type of API Specification file.
    state String
    The current state of the API.
    timeCreated String
    The time this resource was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time this resource was last updated. An RFC3339 formatted datetime string.
    validationResults List<ApiValidationResult>
    Status of each feature available from the API.
    compartmentId string
    (Updatable) The OCID of the compartment in which the resource is created.
    content string
    (Updatable) API Specification content in json or yaml 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"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    lifecycleDetails string
    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
    specificationType string
    Type of API Specification file.
    state string
    The current state of the API.
    timeCreated string
    The time this resource was created. An RFC3339 formatted datetime string.
    timeUpdated string
    The time this resource was last updated. An RFC3339 formatted datetime string.
    validationResults ApiValidationResult[]
    Status of each feature available from the API.
    compartment_id str
    (Updatable) The OCID of the compartment in which the resource is created.
    content str
    (Updatable) API Specification content in json or yaml 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"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    lifecycle_details str
    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
    specification_type str
    Type of API Specification file.
    state str
    The current state of the API.
    time_created str
    The time this resource was created. An RFC3339 formatted datetime string.
    time_updated str
    The time this resource was last updated. An RFC3339 formatted datetime string.
    validation_results Sequence[apigateway.ApiValidationResultArgs]
    Status of each feature available from the API.
    compartmentId String
    (Updatable) The OCID of the compartment in which the resource is created.
    content String
    (Updatable) API Specification content in json or yaml 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"}

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    lifecycleDetails String
    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
    specificationType String
    Type of API Specification file.
    state String
    The current state of the API.
    timeCreated String
    The time this resource was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time this resource was last updated. An RFC3339 formatted datetime string.
    validationResults List<Property Map>
    Status of each feature available from the API.

    Supporting Types

    ApiValidationResult, ApiValidationResultArgs

    Name string
    Name of the validation.
    Result string
    Result of the validation.
    Name string
    Name of the validation.
    Result string
    Result of the validation.
    name String
    Name of the validation.
    result String
    Result of the validation.
    name string
    Name of the validation.
    result string
    Result of the validation.
    name str
    Name of the validation.
    result str
    Result of the validation.
    name String
    Name of the validation.
    result String
    Result of the validation.

    Import

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

    $ pulumi import oci:ApiGateway/api:Api test_api "id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
    pulumi/pulumi-oci