1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. CapacityManagement
  5. OccAvailabilityCatalog
Oracle Cloud Infrastructure v1.36.0 published on Thursday, May 16, 2024 by Pulumi

oci.CapacityManagement.OccAvailabilityCatalog

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.36.0 published on Thursday, May 16, 2024 by Pulumi

    This resource provides the Occ Availability Catalog resource in Oracle Cloud Infrastructure Capacity Management service.

    Create availability catalog

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testOccAvailabilityCatalog = new oci.capacitymanagement.OccAvailabilityCatalog("test_occ_availability_catalog", {
        base64encodedCatalogDetails: occAvailabilityCatalogBase64encodedCatalogDetails,
        compartmentId: compartmentId,
        displayName: occAvailabilityCatalogDisplayName,
        namespace: occAvailabilityCatalogNamespace,
        occCustomerGroupId: testOccCustomerGroup.id,
        definedTags: {
            "foo-namespace.bar-key": "value",
        },
        description: occAvailabilityCatalogDescription,
        freeformTags: {
            "bar-key": "value",
        },
        metadataDetails: {
            formatVersion: occAvailabilityCatalogMetadataDetailsFormatVersion,
        },
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_occ_availability_catalog = oci.capacity_management.OccAvailabilityCatalog("test_occ_availability_catalog",
        base64encoded_catalog_details=occ_availability_catalog_base64encoded_catalog_details,
        compartment_id=compartment_id,
        display_name=occ_availability_catalog_display_name,
        namespace=occ_availability_catalog_namespace,
        occ_customer_group_id=test_occ_customer_group["id"],
        defined_tags={
            "foo-namespace.bar-key": "value",
        },
        description=occ_availability_catalog_description,
        freeform_tags={
            "bar-key": "value",
        },
        metadata_details=oci.capacity_management.OccAvailabilityCatalogMetadataDetailsArgs(
            format_version=occ_availability_catalog_metadata_details_format_version,
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/CapacityManagement"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := CapacityManagement.NewOccAvailabilityCatalog(ctx, "test_occ_availability_catalog", &CapacityManagement.OccAvailabilityCatalogArgs{
    			Base64encodedCatalogDetails: pulumi.Any(occAvailabilityCatalogBase64encodedCatalogDetails),
    			CompartmentId:               pulumi.Any(compartmentId),
    			DisplayName:                 pulumi.Any(occAvailabilityCatalogDisplayName),
    			Namespace:                   pulumi.Any(occAvailabilityCatalogNamespace),
    			OccCustomerGroupId:          pulumi.Any(testOccCustomerGroup.Id),
    			DefinedTags: pulumi.Map{
    				"foo-namespace.bar-key": pulumi.Any("value"),
    			},
    			Description: pulumi.Any(occAvailabilityCatalogDescription),
    			FreeformTags: pulumi.Map{
    				"bar-key": pulumi.Any("value"),
    			},
    			MetadataDetails: &capacitymanagement.OccAvailabilityCatalogMetadataDetailsArgs{
    				FormatVersion: pulumi.Any(occAvailabilityCatalogMetadataDetailsFormatVersion),
    			},
    		})
    		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 testOccAvailabilityCatalog = new Oci.CapacityManagement.OccAvailabilityCatalog("test_occ_availability_catalog", new()
        {
            Base64encodedCatalogDetails = occAvailabilityCatalogBase64encodedCatalogDetails,
            CompartmentId = compartmentId,
            DisplayName = occAvailabilityCatalogDisplayName,
            Namespace = occAvailabilityCatalogNamespace,
            OccCustomerGroupId = testOccCustomerGroup.Id,
            DefinedTags = 
            {
                { "foo-namespace.bar-key", "value" },
            },
            Description = occAvailabilityCatalogDescription,
            FreeformTags = 
            {
                { "bar-key", "value" },
            },
            MetadataDetails = new Oci.CapacityManagement.Inputs.OccAvailabilityCatalogMetadataDetailsArgs
            {
                FormatVersion = occAvailabilityCatalogMetadataDetailsFormatVersion,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.CapacityManagement.OccAvailabilityCatalog;
    import com.pulumi.oci.CapacityManagement.OccAvailabilityCatalogArgs;
    import com.pulumi.oci.CapacityManagement.inputs.OccAvailabilityCatalogMetadataDetailsArgs;
    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 testOccAvailabilityCatalog = new OccAvailabilityCatalog("testOccAvailabilityCatalog", OccAvailabilityCatalogArgs.builder()        
                .base64encodedCatalogDetails(occAvailabilityCatalogBase64encodedCatalogDetails)
                .compartmentId(compartmentId)
                .displayName(occAvailabilityCatalogDisplayName)
                .namespace(occAvailabilityCatalogNamespace)
                .occCustomerGroupId(testOccCustomerGroup.id())
                .definedTags(Map.of("foo-namespace.bar-key", "value"))
                .description(occAvailabilityCatalogDescription)
                .freeformTags(Map.of("bar-key", "value"))
                .metadataDetails(OccAvailabilityCatalogMetadataDetailsArgs.builder()
                    .formatVersion(occAvailabilityCatalogMetadataDetailsFormatVersion)
                    .build())
                .build());
    
        }
    }
    
    resources:
      testOccAvailabilityCatalog:
        type: oci:CapacityManagement:OccAvailabilityCatalog
        name: test_occ_availability_catalog
        properties:
          base64encodedCatalogDetails: ${occAvailabilityCatalogBase64encodedCatalogDetails}
          compartmentId: ${compartmentId}
          displayName: ${occAvailabilityCatalogDisplayName}
          namespace: ${occAvailabilityCatalogNamespace}
          occCustomerGroupId: ${testOccCustomerGroup.id}
          definedTags:
            foo-namespace.bar-key: value
          description: ${occAvailabilityCatalogDescription}
          freeformTags:
            bar-key: value
          metadataDetails:
            formatVersion: ${occAvailabilityCatalogMetadataDetailsFormatVersion}
    

    Create OccAvailabilityCatalog Resource

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

    Constructor syntax

    new OccAvailabilityCatalog(name: string, args: OccAvailabilityCatalogArgs, opts?: CustomResourceOptions);
    @overload
    def OccAvailabilityCatalog(resource_name: str,
                               args: OccAvailabilityCatalogArgs,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def OccAvailabilityCatalog(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               base64encoded_catalog_details: Optional[str] = None,
                               compartment_id: Optional[str] = None,
                               display_name: Optional[str] = None,
                               namespace: Optional[str] = None,
                               occ_customer_group_id: Optional[str] = None,
                               defined_tags: Optional[Mapping[str, Any]] = None,
                               description: Optional[str] = None,
                               freeform_tags: Optional[Mapping[str, Any]] = None,
                               metadata_details: Optional[_capacitymanagement.OccAvailabilityCatalogMetadataDetailsArgs] = None)
    func NewOccAvailabilityCatalog(ctx *Context, name string, args OccAvailabilityCatalogArgs, opts ...ResourceOption) (*OccAvailabilityCatalog, error)
    public OccAvailabilityCatalog(string name, OccAvailabilityCatalogArgs args, CustomResourceOptions? opts = null)
    public OccAvailabilityCatalog(String name, OccAvailabilityCatalogArgs args)
    public OccAvailabilityCatalog(String name, OccAvailabilityCatalogArgs args, CustomResourceOptions options)
    
    type: oci:CapacityManagement:OccAvailabilityCatalog
    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 OccAvailabilityCatalogArgs
    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 OccAvailabilityCatalogArgs
    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 OccAvailabilityCatalogArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OccAvailabilityCatalogArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OccAvailabilityCatalogArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var occAvailabilityCatalogResource = new Oci.CapacityManagement.OccAvailabilityCatalog("occAvailabilityCatalogResource", new()
    {
        Base64encodedCatalogDetails = "string",
        CompartmentId = "string",
        DisplayName = "string",
        Namespace = "string",
        OccCustomerGroupId = "string",
        DefinedTags = 
        {
            { "string", "any" },
        },
        Description = "string",
        FreeformTags = 
        {
            { "string", "any" },
        },
        MetadataDetails = new Oci.CapacityManagement.Inputs.OccAvailabilityCatalogMetadataDetailsArgs
        {
            FormatVersion = "string",
        },
    });
    
    example, err := CapacityManagement.NewOccAvailabilityCatalog(ctx, "occAvailabilityCatalogResource", &CapacityManagement.OccAvailabilityCatalogArgs{
    	Base64encodedCatalogDetails: pulumi.String("string"),
    	CompartmentId:               pulumi.String("string"),
    	DisplayName:                 pulumi.String("string"),
    	Namespace:                   pulumi.String("string"),
    	OccCustomerGroupId:          pulumi.String("string"),
    	DefinedTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	Description: pulumi.String("string"),
    	FreeformTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	MetadataDetails: &capacitymanagement.OccAvailabilityCatalogMetadataDetailsArgs{
    		FormatVersion: pulumi.String("string"),
    	},
    })
    
    var occAvailabilityCatalogResource = new OccAvailabilityCatalog("occAvailabilityCatalogResource", OccAvailabilityCatalogArgs.builder()        
        .base64encodedCatalogDetails("string")
        .compartmentId("string")
        .displayName("string")
        .namespace("string")
        .occCustomerGroupId("string")
        .definedTags(Map.of("string", "any"))
        .description("string")
        .freeformTags(Map.of("string", "any"))
        .metadataDetails(OccAvailabilityCatalogMetadataDetailsArgs.builder()
            .formatVersion("string")
            .build())
        .build());
    
    occ_availability_catalog_resource = oci.capacity_management.OccAvailabilityCatalog("occAvailabilityCatalogResource",
        base64encoded_catalog_details="string",
        compartment_id="string",
        display_name="string",
        namespace="string",
        occ_customer_group_id="string",
        defined_tags={
            "string": "any",
        },
        description="string",
        freeform_tags={
            "string": "any",
        },
        metadata_details=oci.capacity_management.OccAvailabilityCatalogMetadataDetailsArgs(
            format_version="string",
        ))
    
    const occAvailabilityCatalogResource = new oci.capacitymanagement.OccAvailabilityCatalog("occAvailabilityCatalogResource", {
        base64encodedCatalogDetails: "string",
        compartmentId: "string",
        displayName: "string",
        namespace: "string",
        occCustomerGroupId: "string",
        definedTags: {
            string: "any",
        },
        description: "string",
        freeformTags: {
            string: "any",
        },
        metadataDetails: {
            formatVersion: "string",
        },
    });
    
    type: oci:CapacityManagement:OccAvailabilityCatalog
    properties:
        base64encodedCatalogDetails: string
        compartmentId: string
        definedTags:
            string: any
        description: string
        displayName: string
        freeformTags:
            string: any
        metadataDetails:
            formatVersion: string
        namespace: string
        occCustomerGroupId: string
    

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

    Base64encodedCatalogDetails string
    The base 64 encoded string corresponding to the catalog file contents.
    CompartmentId string
    Since all resources are at tenancy level hence this will be the ocid of the tenancy where operation is to be performed.
    DisplayName string
    (Updatable) The display name of the availability catalog.
    Namespace string
    The name of the Oracle Cloud Infrastructure service in consideration. For example, Compute, Exadata, and so on.
    OccCustomerGroupId string

    The OCID of the customer group.

    ** 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

    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) Additional information about the availability catalog.
    FreeformTags Dictionary<string, object>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    MetadataDetails OccAvailabilityCatalogMetadataDetails
    Used for representing the metadata of the catalog. This denotes the version and format of the CSV file for parsing.
    Base64encodedCatalogDetails string
    The base 64 encoded string corresponding to the catalog file contents.
    CompartmentId string
    Since all resources are at tenancy level hence this will be the ocid of the tenancy where operation is to be performed.
    DisplayName string
    (Updatable) The display name of the availability catalog.
    Namespace string
    The name of the Oracle Cloud Infrastructure service in consideration. For example, Compute, Exadata, and so on.
    OccCustomerGroupId string

    The OCID of the customer group.

    ** 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

    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) Additional information about the availability catalog.
    FreeformTags map[string]interface{}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    MetadataDetails OccAvailabilityCatalogMetadataDetailsArgs
    Used for representing the metadata of the catalog. This denotes the version and format of the CSV file for parsing.
    base64encodedCatalogDetails String
    The base 64 encoded string corresponding to the catalog file contents.
    compartmentId String
    Since all resources are at tenancy level hence this will be the ocid of the tenancy where operation is to be performed.
    displayName String
    (Updatable) The display name of the availability catalog.
    namespace String
    The name of the Oracle Cloud Infrastructure service in consideration. For example, Compute, Exadata, and so on.
    occCustomerGroupId String

    The OCID of the customer group.

    ** 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

    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) Additional information about the availability catalog.
    freeformTags Map<String,Object>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    metadataDetails OccAvailabilityCatalogMetadataDetails
    Used for representing the metadata of the catalog. This denotes the version and format of the CSV file for parsing.
    base64encodedCatalogDetails string
    The base 64 encoded string corresponding to the catalog file contents.
    compartmentId string
    Since all resources are at tenancy level hence this will be the ocid of the tenancy where operation is to be performed.
    displayName string
    (Updatable) The display name of the availability catalog.
    namespace string
    The name of the Oracle Cloud Infrastructure service in consideration. For example, Compute, Exadata, and so on.
    occCustomerGroupId string

    The OCID of the customer group.

    ** 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

    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    (Updatable) Additional information about the availability catalog.
    freeformTags {[key: string]: any}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    metadataDetails OccAvailabilityCatalogMetadataDetails
    Used for representing the metadata of the catalog. This denotes the version and format of the CSV file for parsing.
    base64encoded_catalog_details str
    The base 64 encoded string corresponding to the catalog file contents.
    compartment_id str
    Since all resources are at tenancy level hence this will be the ocid of the tenancy where operation is to be performed.
    display_name str
    (Updatable) The display name of the availability catalog.
    namespace str
    The name of the Oracle Cloud Infrastructure service in consideration. For example, Compute, Exadata, and so on.
    occ_customer_group_id str

    The OCID of the customer group.

    ** 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

    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    (Updatable) Additional information about the availability catalog.
    freeform_tags Mapping[str, Any]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    metadata_details capacitymanagement.OccAvailabilityCatalogMetadataDetailsArgs
    Used for representing the metadata of the catalog. This denotes the version and format of the CSV file for parsing.
    base64encodedCatalogDetails String
    The base 64 encoded string corresponding to the catalog file contents.
    compartmentId String
    Since all resources are at tenancy level hence this will be the ocid of the tenancy where operation is to be performed.
    displayName String
    (Updatable) The display name of the availability catalog.
    namespace String
    The name of the Oracle Cloud Infrastructure service in consideration. For example, Compute, Exadata, and so on.
    occCustomerGroupId String

    The OCID of the customer group.

    ** 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

    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) Additional information about the availability catalog.
    freeformTags Map<Any>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    metadataDetails Property Map
    Used for representing the metadata of the catalog. This denotes the version and format of the CSV file for parsing.

    Outputs

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

    CatalogState string
    The different states associated with the availability catalog.
    Details List<OccAvailabilityCatalogDetail>
    Details about capacity available for different resources in catalog.
    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 lifecycle state of the resource.
    SystemTags Dictionary<string, object>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time when the availability catalog was created.
    TimeUpdated string
    The time when the availability catalog was last updated.
    CatalogState string
    The different states associated with the availability catalog.
    Details []OccAvailabilityCatalogDetail
    Details about capacity available for different resources in catalog.
    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 lifecycle state of the resource.
    SystemTags map[string]interface{}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time when the availability catalog was created.
    TimeUpdated string
    The time when the availability catalog was last updated.
    catalogState String
    The different states associated with the availability catalog.
    details List<OccAvailabilityCatalogDetail>
    Details about capacity available for different resources in catalog.
    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 lifecycle state of the resource.
    systemTags Map<String,Object>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time when the availability catalog was created.
    timeUpdated String
    The time when the availability catalog was last updated.
    catalogState string
    The different states associated with the availability catalog.
    details OccAvailabilityCatalogDetail[]
    Details about capacity available for different resources in catalog.
    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 lifecycle state of the resource.
    systemTags {[key: string]: any}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time when the availability catalog was created.
    timeUpdated string
    The time when the availability catalog was last updated.
    catalog_state str
    The different states associated with the availability catalog.
    details Sequence[capacitymanagement.OccAvailabilityCatalogDetail]
    Details about capacity available for different resources in catalog.
    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 lifecycle state of the resource.
    system_tags Mapping[str, Any]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time when the availability catalog was created.
    time_updated str
    The time when the availability catalog was last updated.
    catalogState String
    The different states associated with the availability catalog.
    details List<Property Map>
    Details about capacity available for different resources in catalog.
    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 lifecycle state of the resource.
    systemTags Map<Any>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time when the availability catalog was created.
    timeUpdated String
    The time when the availability catalog was last updated.

    Look up Existing OccAvailabilityCatalog Resource

    Get an existing OccAvailabilityCatalog 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?: OccAvailabilityCatalogState, opts?: CustomResourceOptions): OccAvailabilityCatalog
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            base64encoded_catalog_details: Optional[str] = None,
            catalog_state: Optional[str] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            description: Optional[str] = None,
            details: Optional[Sequence[_capacitymanagement.OccAvailabilityCatalogDetailArgs]] = None,
            display_name: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            lifecycle_details: Optional[str] = None,
            metadata_details: Optional[_capacitymanagement.OccAvailabilityCatalogMetadataDetailsArgs] = None,
            namespace: Optional[str] = None,
            occ_customer_group_id: Optional[str] = None,
            state: Optional[str] = None,
            system_tags: Optional[Mapping[str, Any]] = None,
            time_created: Optional[str] = None,
            time_updated: Optional[str] = None) -> OccAvailabilityCatalog
    func GetOccAvailabilityCatalog(ctx *Context, name string, id IDInput, state *OccAvailabilityCatalogState, opts ...ResourceOption) (*OccAvailabilityCatalog, error)
    public static OccAvailabilityCatalog Get(string name, Input<string> id, OccAvailabilityCatalogState? state, CustomResourceOptions? opts = null)
    public static OccAvailabilityCatalog get(String name, Output<String> id, OccAvailabilityCatalogState 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:
    Base64encodedCatalogDetails string
    The base 64 encoded string corresponding to the catalog file contents.
    CatalogState string
    The different states associated with the availability catalog.
    CompartmentId string
    Since all resources are at tenancy level hence this will be the ocid of the tenancy where operation is to be performed.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) Additional information about the availability catalog.
    Details List<OccAvailabilityCatalogDetail>
    Details about capacity available for different resources in catalog.
    DisplayName string
    (Updatable) The display name of the availability catalog.
    FreeformTags Dictionary<string, object>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    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.
    MetadataDetails OccAvailabilityCatalogMetadataDetails
    Used for representing the metadata of the catalog. This denotes the version and format of the CSV file for parsing.
    Namespace string
    The name of the Oracle Cloud Infrastructure service in consideration. For example, Compute, Exadata, and so on.
    OccCustomerGroupId string

    The OCID of the customer group.

    ** 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

    State string
    The current lifecycle state of the resource.
    SystemTags Dictionary<string, object>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time when the availability catalog was created.
    TimeUpdated string
    The time when the availability catalog was last updated.
    Base64encodedCatalogDetails string
    The base 64 encoded string corresponding to the catalog file contents.
    CatalogState string
    The different states associated with the availability catalog.
    CompartmentId string
    Since all resources are at tenancy level hence this will be the ocid of the tenancy where operation is to be performed.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) Additional information about the availability catalog.
    Details []OccAvailabilityCatalogDetailArgs
    Details about capacity available for different resources in catalog.
    DisplayName string
    (Updatable) The display name of the availability catalog.
    FreeformTags map[string]interface{}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    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.
    MetadataDetails OccAvailabilityCatalogMetadataDetailsArgs
    Used for representing the metadata of the catalog. This denotes the version and format of the CSV file for parsing.
    Namespace string
    The name of the Oracle Cloud Infrastructure service in consideration. For example, Compute, Exadata, and so on.
    OccCustomerGroupId string

    The OCID of the customer group.

    ** 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

    State string
    The current lifecycle state of the resource.
    SystemTags map[string]interface{}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time when the availability catalog was created.
    TimeUpdated string
    The time when the availability catalog was last updated.
    base64encodedCatalogDetails String
    The base 64 encoded string corresponding to the catalog file contents.
    catalogState String
    The different states associated with the availability catalog.
    compartmentId String
    Since all resources are at tenancy level hence this will be the ocid of the tenancy where operation is to be performed.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) Additional information about the availability catalog.
    details List<OccAvailabilityCatalogDetail>
    Details about capacity available for different resources in catalog.
    displayName String
    (Updatable) The display name of the availability catalog.
    freeformTags Map<String,Object>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    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.
    metadataDetails OccAvailabilityCatalogMetadataDetails
    Used for representing the metadata of the catalog. This denotes the version and format of the CSV file for parsing.
    namespace String
    The name of the Oracle Cloud Infrastructure service in consideration. For example, Compute, Exadata, and so on.
    occCustomerGroupId String

    The OCID of the customer group.

    ** 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

    state String
    The current lifecycle state of the resource.
    systemTags Map<String,Object>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time when the availability catalog was created.
    timeUpdated String
    The time when the availability catalog was last updated.
    base64encodedCatalogDetails string
    The base 64 encoded string corresponding to the catalog file contents.
    catalogState string
    The different states associated with the availability catalog.
    compartmentId string
    Since all resources are at tenancy level hence this will be the ocid of the tenancy where operation is to be performed.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    (Updatable) Additional information about the availability catalog.
    details OccAvailabilityCatalogDetail[]
    Details about capacity available for different resources in catalog.
    displayName string
    (Updatable) The display name of the availability catalog.
    freeformTags {[key: string]: any}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    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.
    metadataDetails OccAvailabilityCatalogMetadataDetails
    Used for representing the metadata of the catalog. This denotes the version and format of the CSV file for parsing.
    namespace string
    The name of the Oracle Cloud Infrastructure service in consideration. For example, Compute, Exadata, and so on.
    occCustomerGroupId string

    The OCID of the customer group.

    ** 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

    state string
    The current lifecycle state of the resource.
    systemTags {[key: string]: any}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time when the availability catalog was created.
    timeUpdated string
    The time when the availability catalog was last updated.
    base64encoded_catalog_details str
    The base 64 encoded string corresponding to the catalog file contents.
    catalog_state str
    The different states associated with the availability catalog.
    compartment_id str
    Since all resources are at tenancy level hence this will be the ocid of the tenancy where operation is to be performed.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    (Updatable) Additional information about the availability catalog.
    details Sequence[capacitymanagement.OccAvailabilityCatalogDetailArgs]
    Details about capacity available for different resources in catalog.
    display_name str
    (Updatable) The display name of the availability catalog.
    freeform_tags Mapping[str, Any]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    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.
    metadata_details capacitymanagement.OccAvailabilityCatalogMetadataDetailsArgs
    Used for representing the metadata of the catalog. This denotes the version and format of the CSV file for parsing.
    namespace str
    The name of the Oracle Cloud Infrastructure service in consideration. For example, Compute, Exadata, and so on.
    occ_customer_group_id str

    The OCID of the customer group.

    ** 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

    state str
    The current lifecycle state of the resource.
    system_tags Mapping[str, Any]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time when the availability catalog was created.
    time_updated str
    The time when the availability catalog was last updated.
    base64encodedCatalogDetails String
    The base 64 encoded string corresponding to the catalog file contents.
    catalogState String
    The different states associated with the availability catalog.
    compartmentId String
    Since all resources are at tenancy level hence this will be the ocid of the tenancy where operation is to be performed.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) Additional information about the availability catalog.
    details List<Property Map>
    Details about capacity available for different resources in catalog.
    displayName String
    (Updatable) The display name of the availability catalog.
    freeformTags Map<Any>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    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.
    metadataDetails Property Map
    Used for representing the metadata of the catalog. This denotes the version and format of the CSV file for parsing.
    namespace String
    The name of the Oracle Cloud Infrastructure service in consideration. For example, Compute, Exadata, and so on.
    occCustomerGroupId String

    The OCID of the customer group.

    ** 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

    state String
    The current lifecycle state of the resource.
    systemTags Map<Any>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time when the availability catalog was created.
    timeUpdated String
    The time when the availability catalog was last updated.

    Supporting Types

    OccAvailabilityCatalogDetail, OccAvailabilityCatalogDetailArgs

    AvailableQuantity string
    The quantity of available resource that the customer can request.
    CatalogId string
    The OCID of the availability catalog.
    DateExpectedCapacityHandover string
    The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled.
    DateFinalCustomerOrder string
    The date by which the customer must place the order to have their capacity requirements met by the customer handover date.
    Namespace string
    The name of the Oracle Cloud Infrastructure service in consideration. For example, Compute, Exadata, and so on.
    ResourceName string
    The name of the resource that the customer can request.
    ResourceType string
    The different types of resources against which customers can place capacity requests.
    Unit string
    The unit in which the resource available is measured.
    WorkloadType string
    The type of workload (Generic/ROW).
    AvailableQuantity string
    The quantity of available resource that the customer can request.
    CatalogId string
    The OCID of the availability catalog.
    DateExpectedCapacityHandover string
    The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled.
    DateFinalCustomerOrder string
    The date by which the customer must place the order to have their capacity requirements met by the customer handover date.
    Namespace string
    The name of the Oracle Cloud Infrastructure service in consideration. For example, Compute, Exadata, and so on.
    ResourceName string
    The name of the resource that the customer can request.
    ResourceType string
    The different types of resources against which customers can place capacity requests.
    Unit string
    The unit in which the resource available is measured.
    WorkloadType string
    The type of workload (Generic/ROW).
    availableQuantity String
    The quantity of available resource that the customer can request.
    catalogId String
    The OCID of the availability catalog.
    dateExpectedCapacityHandover String
    The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled.
    dateFinalCustomerOrder String
    The date by which the customer must place the order to have their capacity requirements met by the customer handover date.
    namespace String
    The name of the Oracle Cloud Infrastructure service in consideration. For example, Compute, Exadata, and so on.
    resourceName String
    The name of the resource that the customer can request.
    resourceType String
    The different types of resources against which customers can place capacity requests.
    unit String
    The unit in which the resource available is measured.
    workloadType String
    The type of workload (Generic/ROW).
    availableQuantity string
    The quantity of available resource that the customer can request.
    catalogId string
    The OCID of the availability catalog.
    dateExpectedCapacityHandover string
    The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled.
    dateFinalCustomerOrder string
    The date by which the customer must place the order to have their capacity requirements met by the customer handover date.
    namespace string
    The name of the Oracle Cloud Infrastructure service in consideration. For example, Compute, Exadata, and so on.
    resourceName string
    The name of the resource that the customer can request.
    resourceType string
    The different types of resources against which customers can place capacity requests.
    unit string
    The unit in which the resource available is measured.
    workloadType string
    The type of workload (Generic/ROW).
    available_quantity str
    The quantity of available resource that the customer can request.
    catalog_id str
    The OCID of the availability catalog.
    date_expected_capacity_handover str
    The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled.
    date_final_customer_order str
    The date by which the customer must place the order to have their capacity requirements met by the customer handover date.
    namespace str
    The name of the Oracle Cloud Infrastructure service in consideration. For example, Compute, Exadata, and so on.
    resource_name str
    The name of the resource that the customer can request.
    resource_type str
    The different types of resources against which customers can place capacity requests.
    unit str
    The unit in which the resource available is measured.
    workload_type str
    The type of workload (Generic/ROW).
    availableQuantity String
    The quantity of available resource that the customer can request.
    catalogId String
    The OCID of the availability catalog.
    dateExpectedCapacityHandover String
    The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled.
    dateFinalCustomerOrder String
    The date by which the customer must place the order to have their capacity requirements met by the customer handover date.
    namespace String
    The name of the Oracle Cloud Infrastructure service in consideration. For example, Compute, Exadata, and so on.
    resourceName String
    The name of the resource that the customer can request.
    resourceType String
    The different types of resources against which customers can place capacity requests.
    unit String
    The unit in which the resource available is measured.
    workloadType String
    The type of workload (Generic/ROW).

    OccAvailabilityCatalogMetadataDetails, OccAvailabilityCatalogMetadataDetailsArgs

    FormatVersion string
    The version for the format of the catalog file being uploaded.
    FormatVersion string
    The version for the format of the catalog file being uploaded.
    formatVersion String
    The version for the format of the catalog file being uploaded.
    formatVersion string
    The version for the format of the catalog file being uploaded.
    format_version str
    The version for the format of the catalog file being uploaded.
    formatVersion String
    The version for the format of the catalog file being uploaded.

    Import

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

    $ pulumi import oci:CapacityManagement/occAvailabilityCatalog:OccAvailabilityCatalog test_occ_availability_catalog "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.36.0 published on Thursday, May 16, 2024 by Pulumi