Docs Home
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm.OnboardingCatalogPlan
Explore with Pulumi AI
Note - Intended for internal use only. This resource is strictly experimental and subject to change without notice.
Create, update, and delete onboarding_catalog_plans with this resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";
const onboardingCatalogPlanInstance = new ibm.OnboardingCatalogPlan("onboardingCatalogPlanInstance", {
active: true,
catalogProductId: ibm_onboarding_catalog_product.onboarding_catalog_product_instance.onboarding_catalog_product_id,
disabled: false,
kind: "plan",
metadata: {
rcCompatible: true,
ui: {
strings: {
en: {
bullets: [{
description: "description",
title: "title",
}],
media: [{
caption: "caption",
thumbnail: "thumbnail",
type: "image",
url: "url",
}],
navigationItems: [{
id: "id",
url: "url",
label: "label",
}],
},
},
urls: {
docUrl: "doc_url",
apidocsUrl: "apidocs_url",
termsUrl: "terms_url",
instructionsUrl: "instructions_url",
catalogDetailsUrl: "catalog_details_url",
customCreatePageUrl: "custom_create_page_url",
dashboard: "dashboard",
},
hidden: true,
sideBySideIndex: 1,
},
service: {
rcProvisionable: true,
iamCompatible: true,
bindable: true,
planUpdateable: true,
serviceKeySupported: true,
},
pricing: {
type: "free",
origin: "global_catalog",
salesAvenues: ["seller"],
},
plan: {
allowInternalUsers: true,
provisionType: "ibm_cloud",
reservable: true,
},
other: {
resourceController: {
subscriptionProviderId: "subscription_provider_id",
},
},
},
objectProvider: {
name: "name",
email: "email",
},
overviewUi: {
en: {
displayName: "display_name",
description: "description",
longDescription: "long_description",
},
},
productId: ibm_onboarding_product.onboarding_product_instance.id,
});
import pulumi
import pulumi_ibm as ibm
onboarding_catalog_plan_instance = ibm.OnboardingCatalogPlan("onboardingCatalogPlanInstance",
active=True,
catalog_product_id=ibm_onboarding_catalog_product["onboarding_catalog_product_instance"]["onboarding_catalog_product_id"],
disabled=False,
kind="plan",
metadata={
"rc_compatible": True,
"ui": {
"strings": {
"en": {
"bullets": [{
"description": "description",
"title": "title",
}],
"media": [{
"caption": "caption",
"thumbnail": "thumbnail",
"type": "image",
"url": "url",
}],
"navigation_items": [{
"id": "id",
"url": "url",
"label": "label",
}],
},
},
"urls": {
"doc_url": "doc_url",
"apidocs_url": "apidocs_url",
"terms_url": "terms_url",
"instructions_url": "instructions_url",
"catalog_details_url": "catalog_details_url",
"custom_create_page_url": "custom_create_page_url",
"dashboard": "dashboard",
},
"hidden": True,
"side_by_side_index": 1,
},
"service": {
"rc_provisionable": True,
"iam_compatible": True,
"bindable": True,
"plan_updateable": True,
"service_key_supported": True,
},
"pricing": {
"type": "free",
"origin": "global_catalog",
"sales_avenues": ["seller"],
},
"plan": {
"allow_internal_users": True,
"provision_type": "ibm_cloud",
"reservable": True,
},
"other": {
"resource_controller": {
"subscription_provider_id": "subscription_provider_id",
},
},
},
object_provider={
"name": "name",
"email": "email",
},
overview_ui={
"en": {
"display_name": "display_name",
"description": "description",
"long_description": "long_description",
},
},
product_id=ibm_onboarding_product["onboarding_product_instance"]["id"])
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ibm.NewOnboardingCatalogPlan(ctx, "onboardingCatalogPlanInstance", &ibm.OnboardingCatalogPlanArgs{
Active: pulumi.Bool(true),
CatalogProductId: pulumi.Any(ibm_onboarding_catalog_product.Onboarding_catalog_product_instance.Onboarding_catalog_product_id),
Disabled: pulumi.Bool(false),
Kind: pulumi.String("plan"),
Metadata: &ibm.OnboardingCatalogPlanMetadataArgs{
RcCompatible: pulumi.Bool(true),
Ui: &ibm.OnboardingCatalogPlanMetadataUiArgs{
Strings: &ibm.OnboardingCatalogPlanMetadataUiStringsArgs{
En: &ibm.OnboardingCatalogPlanMetadataUiStringsEnArgs{
Bullets: ibm.OnboardingCatalogPlanMetadataUiStringsEnBulletArray{
&ibm.OnboardingCatalogPlanMetadataUiStringsEnBulletArgs{
Description: pulumi.String("description"),
Title: pulumi.String("title"),
},
},
Media: ibm.OnboardingCatalogPlanMetadataUiStringsEnMediaArray{
&ibm.OnboardingCatalogPlanMetadataUiStringsEnMediaArgs{
Caption: pulumi.String("caption"),
Thumbnail: pulumi.String("thumbnail"),
Type: pulumi.String("image"),
Url: pulumi.String("url"),
},
},
NavigationItems: ibm.OnboardingCatalogPlanMetadataUiStringsEnNavigationItemArray{
&ibm.OnboardingCatalogPlanMetadataUiStringsEnNavigationItemArgs{
Id: pulumi.String("id"),
Url: pulumi.String("url"),
Label: pulumi.String("label"),
},
},
},
},
Urls: &ibm.OnboardingCatalogPlanMetadataUiUrlsArgs{
DocUrl: pulumi.String("doc_url"),
ApidocsUrl: pulumi.String("apidocs_url"),
TermsUrl: pulumi.String("terms_url"),
InstructionsUrl: pulumi.String("instructions_url"),
CatalogDetailsUrl: pulumi.String("catalog_details_url"),
CustomCreatePageUrl: pulumi.String("custom_create_page_url"),
Dashboard: pulumi.String("dashboard"),
},
Hidden: pulumi.Bool(true),
SideBySideIndex: pulumi.Float64(1),
},
Service: &ibm.OnboardingCatalogPlanMetadataServiceArgs{
RcProvisionable: pulumi.Bool(true),
IamCompatible: pulumi.Bool(true),
Bindable: pulumi.Bool(true),
PlanUpdateable: pulumi.Bool(true),
ServiceKeySupported: pulumi.Bool(true),
},
Pricing: &ibm.OnboardingCatalogPlanMetadataPricingArgs{
Type: pulumi.String("free"),
Origin: pulumi.String("global_catalog"),
SalesAvenues: pulumi.StringArray{
pulumi.String("seller"),
},
},
Plan: &ibm.OnboardingCatalogPlanMetadataPlanArgs{
AllowInternalUsers: pulumi.Bool(true),
ProvisionType: pulumi.String("ibm_cloud"),
Reservable: pulumi.Bool(true),
},
Other: &ibm.OnboardingCatalogPlanMetadataOtherArgs{
ResourceController: &ibm.OnboardingCatalogPlanMetadataOtherResourceControllerArgs{
SubscriptionProviderId: pulumi.String("subscription_provider_id"),
},
},
},
ObjectProvider: &ibm.OnboardingCatalogPlanObjectProviderArgs{
Name: pulumi.String("name"),
Email: pulumi.String("email"),
},
OverviewUi: &ibm.OnboardingCatalogPlanOverviewUiArgs{
En: &ibm.OnboardingCatalogPlanOverviewUiEnArgs{
DisplayName: pulumi.String("display_name"),
Description: pulumi.String("description"),
LongDescription: pulumi.String("long_description"),
},
},
ProductId: pulumi.Any(ibm_onboarding_product.Onboarding_product_instance.Id),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;
return await Deployment.RunAsync(() =>
{
var onboardingCatalogPlanInstance = new Ibm.OnboardingCatalogPlan("onboardingCatalogPlanInstance", new()
{
Active = true,
CatalogProductId = ibm_onboarding_catalog_product.Onboarding_catalog_product_instance.Onboarding_catalog_product_id,
Disabled = false,
Kind = "plan",
Metadata = new Ibm.Inputs.OnboardingCatalogPlanMetadataArgs
{
RcCompatible = true,
Ui = new Ibm.Inputs.OnboardingCatalogPlanMetadataUiArgs
{
Strings = new Ibm.Inputs.OnboardingCatalogPlanMetadataUiStringsArgs
{
En = new Ibm.Inputs.OnboardingCatalogPlanMetadataUiStringsEnArgs
{
Bullets = new[]
{
new Ibm.Inputs.OnboardingCatalogPlanMetadataUiStringsEnBulletArgs
{
Description = "description",
Title = "title",
},
},
Media = new[]
{
new Ibm.Inputs.OnboardingCatalogPlanMetadataUiStringsEnMediaArgs
{
Caption = "caption",
Thumbnail = "thumbnail",
Type = "image",
Url = "url",
},
},
NavigationItems = new[]
{
new Ibm.Inputs.OnboardingCatalogPlanMetadataUiStringsEnNavigationItemArgs
{
Id = "id",
Url = "url",
Label = "label",
},
},
},
},
Urls = new Ibm.Inputs.OnboardingCatalogPlanMetadataUiUrlsArgs
{
DocUrl = "doc_url",
ApidocsUrl = "apidocs_url",
TermsUrl = "terms_url",
InstructionsUrl = "instructions_url",
CatalogDetailsUrl = "catalog_details_url",
CustomCreatePageUrl = "custom_create_page_url",
Dashboard = "dashboard",
},
Hidden = true,
SideBySideIndex = 1,
},
Service = new Ibm.Inputs.OnboardingCatalogPlanMetadataServiceArgs
{
RcProvisionable = true,
IamCompatible = true,
Bindable = true,
PlanUpdateable = true,
ServiceKeySupported = true,
},
Pricing = new Ibm.Inputs.OnboardingCatalogPlanMetadataPricingArgs
{
Type = "free",
Origin = "global_catalog",
SalesAvenues = new[]
{
"seller",
},
},
Plan = new Ibm.Inputs.OnboardingCatalogPlanMetadataPlanArgs
{
AllowInternalUsers = true,
ProvisionType = "ibm_cloud",
Reservable = true,
},
Other = new Ibm.Inputs.OnboardingCatalogPlanMetadataOtherArgs
{
ResourceController = new Ibm.Inputs.OnboardingCatalogPlanMetadataOtherResourceControllerArgs
{
SubscriptionProviderId = "subscription_provider_id",
},
},
},
ObjectProvider = new Ibm.Inputs.OnboardingCatalogPlanObjectProviderArgs
{
Name = "name",
Email = "email",
},
OverviewUi = new Ibm.Inputs.OnboardingCatalogPlanOverviewUiArgs
{
En = new Ibm.Inputs.OnboardingCatalogPlanOverviewUiEnArgs
{
DisplayName = "display_name",
Description = "description",
LongDescription = "long_description",
},
},
ProductId = ibm_onboarding_product.Onboarding_product_instance.Id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.OnboardingCatalogPlan;
import com.pulumi.ibm.OnboardingCatalogPlanArgs;
import com.pulumi.ibm.inputs.OnboardingCatalogPlanMetadataArgs;
import com.pulumi.ibm.inputs.OnboardingCatalogPlanMetadataUiArgs;
import com.pulumi.ibm.inputs.OnboardingCatalogPlanMetadataUiStringsArgs;
import com.pulumi.ibm.inputs.OnboardingCatalogPlanMetadataUiStringsEnArgs;
import com.pulumi.ibm.inputs.OnboardingCatalogPlanMetadataUiUrlsArgs;
import com.pulumi.ibm.inputs.OnboardingCatalogPlanMetadataServiceArgs;
import com.pulumi.ibm.inputs.OnboardingCatalogPlanMetadataPricingArgs;
import com.pulumi.ibm.inputs.OnboardingCatalogPlanMetadataPlanArgs;
import com.pulumi.ibm.inputs.OnboardingCatalogPlanMetadataOtherArgs;
import com.pulumi.ibm.inputs.OnboardingCatalogPlanMetadataOtherResourceControllerArgs;
import com.pulumi.ibm.inputs.OnboardingCatalogPlanObjectProviderArgs;
import com.pulumi.ibm.inputs.OnboardingCatalogPlanOverviewUiArgs;
import com.pulumi.ibm.inputs.OnboardingCatalogPlanOverviewUiEnArgs;
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 onboardingCatalogPlanInstance = new OnboardingCatalogPlan("onboardingCatalogPlanInstance", OnboardingCatalogPlanArgs.builder()
.active(true)
.catalogProductId(ibm_onboarding_catalog_product.onboarding_catalog_product_instance().onboarding_catalog_product_id())
.disabled(false)
.kind("plan")
.metadata(OnboardingCatalogPlanMetadataArgs.builder()
.rcCompatible(true)
.ui(OnboardingCatalogPlanMetadataUiArgs.builder()
.strings(OnboardingCatalogPlanMetadataUiStringsArgs.builder()
.en(OnboardingCatalogPlanMetadataUiStringsEnArgs.builder()
.bullets(OnboardingCatalogPlanMetadataUiStringsEnBulletArgs.builder()
.description("description")
.title("title")
.build())
.media(OnboardingCatalogPlanMetadataUiStringsEnMediaArgs.builder()
.caption("caption")
.thumbnail("thumbnail")
.type("image")
.url("url")
.build())
.navigationItems(OnboardingCatalogPlanMetadataUiStringsEnNavigationItemArgs.builder()
.id("id")
.url("url")
.label("label")
.build())
.build())
.build())
.urls(OnboardingCatalogPlanMetadataUiUrlsArgs.builder()
.docUrl("doc_url")
.apidocsUrl("apidocs_url")
.termsUrl("terms_url")
.instructionsUrl("instructions_url")
.catalogDetailsUrl("catalog_details_url")
.customCreatePageUrl("custom_create_page_url")
.dashboard("dashboard")
.build())
.hidden(true)
.sideBySideIndex(1)
.build())
.service(OnboardingCatalogPlanMetadataServiceArgs.builder()
.rcProvisionable(true)
.iamCompatible(true)
.bindable(true)
.planUpdateable(true)
.serviceKeySupported(true)
.build())
.pricing(OnboardingCatalogPlanMetadataPricingArgs.builder()
.type("free")
.origin("global_catalog")
.salesAvenues("seller")
.build())
.plan(OnboardingCatalogPlanMetadataPlanArgs.builder()
.allowInternalUsers(true)
.provisionType("ibm_cloud")
.reservable(true)
.build())
.other(OnboardingCatalogPlanMetadataOtherArgs.builder()
.resourceController(OnboardingCatalogPlanMetadataOtherResourceControllerArgs.builder()
.subscriptionProviderId("subscription_provider_id")
.build())
.build())
.build())
.objectProvider(OnboardingCatalogPlanObjectProviderArgs.builder()
.name("name")
.email("email")
.build())
.overviewUi(OnboardingCatalogPlanOverviewUiArgs.builder()
.en(OnboardingCatalogPlanOverviewUiEnArgs.builder()
.displayName("display_name")
.description("description")
.longDescription("long_description")
.build())
.build())
.productId(ibm_onboarding_product.onboarding_product_instance().id())
.build());
}
}
resources:
onboardingCatalogPlanInstance:
type: ibm:OnboardingCatalogPlan
properties:
active: true
catalogProductId: ${ibm_onboarding_catalog_product.onboarding_catalog_product_instance.onboarding_catalog_product_id}
disabled: false
kind: plan
metadata:
rcCompatible: true
ui:
strings:
en:
bullets:
- description: description
title: title
media:
- caption: caption
thumbnail: thumbnail
type: image
url: url
navigationItems:
- id: id
url: url
label: label
urls:
docUrl: doc_url
apidocsUrl: apidocs_url
termsUrl: terms_url
instructionsUrl: instructions_url
catalogDetailsUrl: catalog_details_url
customCreatePageUrl: custom_create_page_url
dashboard: dashboard
hidden: true
sideBySideIndex: 1
service:
rcProvisionable: true
iamCompatible: true
bindable: true
planUpdateable: true
serviceKeySupported: true
pricing:
type: free
origin: global_catalog
salesAvenues:
- seller
plan:
allowInternalUsers: true
provisionType: ibm_cloud
reservable: true
other:
resourceController:
subscriptionProviderId: subscription_provider_id
objectProvider:
name: name
email: email
overviewUi:
en:
displayName: display_name
description: description
longDescription: long_description
productId: ${ibm_onboarding_product.onboarding_product_instance.id}
Create OnboardingCatalogPlan Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new OnboardingCatalogPlan(name: string, args: OnboardingCatalogPlanArgs, opts?: CustomResourceOptions);@overload
def OnboardingCatalogPlan(resource_name: str,
args: OnboardingCatalogPlanArgs,
opts: Optional[ResourceOptions] = None)
@overload
def OnboardingCatalogPlan(resource_name: str,
opts: Optional[ResourceOptions] = None,
active: Optional[bool] = None,
catalog_product_id: Optional[str] = None,
disabled: Optional[bool] = None,
product_id: Optional[str] = None,
kind: Optional[str] = None,
object_provider: Optional[OnboardingCatalogPlanObjectProviderArgs] = None,
name: Optional[str] = None,
object_id: Optional[str] = None,
metadata: Optional[OnboardingCatalogPlanMetadataArgs] = None,
onboarding_catalog_plan_id: Optional[str] = None,
overview_ui: Optional[OnboardingCatalogPlanOverviewUiArgs] = None,
pricing_tags: Optional[Sequence[str]] = None,
env: Optional[str] = None,
tags: Optional[Sequence[str]] = None)func NewOnboardingCatalogPlan(ctx *Context, name string, args OnboardingCatalogPlanArgs, opts ...ResourceOption) (*OnboardingCatalogPlan, error)public OnboardingCatalogPlan(string name, OnboardingCatalogPlanArgs args, CustomResourceOptions? opts = null)
public OnboardingCatalogPlan(String name, OnboardingCatalogPlanArgs args)
public OnboardingCatalogPlan(String name, OnboardingCatalogPlanArgs args, CustomResourceOptions options)
type: ibm:OnboardingCatalogPlan
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 OnboardingCatalogPlanArgs
- 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 OnboardingCatalogPlanArgs
- 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 OnboardingCatalogPlanArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OnboardingCatalogPlanArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OnboardingCatalogPlanArgs
- 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 onboardingCatalogPlanResource = new Ibm.OnboardingCatalogPlan("onboardingCatalogPlanResource", new()
{
Active = false,
CatalogProductId = "string",
Disabled = false,
ProductId = "string",
Kind = "string",
ObjectProvider = new Ibm.Inputs.OnboardingCatalogPlanObjectProviderArgs
{
Email = "string",
Name = "string",
},
Name = "string",
ObjectId = "string",
Metadata = new Ibm.Inputs.OnboardingCatalogPlanMetadataArgs
{
Other = new Ibm.Inputs.OnboardingCatalogPlanMetadataOtherArgs
{
ResourceController = new Ibm.Inputs.OnboardingCatalogPlanMetadataOtherResourceControllerArgs
{
SubscriptionProviderId = "string",
},
},
Plan = new Ibm.Inputs.OnboardingCatalogPlanMetadataPlanArgs
{
AllowInternalUsers = false,
Bindable = false,
ProvisionType = "string",
Reservable = false,
},
Pricing = new Ibm.Inputs.OnboardingCatalogPlanMetadataPricingArgs
{
Origin = "string",
SalesAvenues = new[]
{
"string",
},
Type = "string",
},
RcCompatible = false,
Service = new Ibm.Inputs.OnboardingCatalogPlanMetadataServiceArgs
{
Bindable = false,
IamCompatible = false,
PlanUpdateable = false,
RcProvisionable = false,
ServiceKeySupported = false,
UniqueApiKey = false,
},
Ui = new Ibm.Inputs.OnboardingCatalogPlanMetadataUiArgs
{
Hidden = false,
SideBySideIndex = 0,
Strings = new Ibm.Inputs.OnboardingCatalogPlanMetadataUiStringsArgs
{
En = new Ibm.Inputs.OnboardingCatalogPlanMetadataUiStringsEnArgs
{
Bullets = new[]
{
new Ibm.Inputs.OnboardingCatalogPlanMetadataUiStringsEnBulletArgs
{
Description = "string",
Title = "string",
},
},
Media = new[]
{
new Ibm.Inputs.OnboardingCatalogPlanMetadataUiStringsEnMediaArgs
{
Caption = "string",
Type = "string",
Url = "string",
Thumbnail = "string",
},
},
NavigationItems = new[]
{
new Ibm.Inputs.OnboardingCatalogPlanMetadataUiStringsEnNavigationItemArgs
{
Id = "string",
Label = "string",
Url = "string",
},
},
},
},
Urls = new Ibm.Inputs.OnboardingCatalogPlanMetadataUiUrlsArgs
{
ApidocsUrl = "string",
CatalogDetailsUrl = "string",
CustomCreatePageUrl = "string",
Dashboard = "string",
DocUrl = "string",
InstructionsUrl = "string",
TermsUrl = "string",
},
},
},
OnboardingCatalogPlanId = "string",
OverviewUi = new Ibm.Inputs.OnboardingCatalogPlanOverviewUiArgs
{
En = new Ibm.Inputs.OnboardingCatalogPlanOverviewUiEnArgs
{
Description = "string",
DisplayName = "string",
LongDescription = "string",
},
},
PricingTags = new[]
{
"string",
},
Env = "string",
Tags = new[]
{
"string",
},
});
example, err := ibm.NewOnboardingCatalogPlan(ctx, "onboardingCatalogPlanResource", &ibm.OnboardingCatalogPlanArgs{
Active: pulumi.Bool(false),
CatalogProductId: pulumi.String("string"),
Disabled: pulumi.Bool(false),
ProductId: pulumi.String("string"),
Kind: pulumi.String("string"),
ObjectProvider: &ibm.OnboardingCatalogPlanObjectProviderArgs{
Email: pulumi.String("string"),
Name: pulumi.String("string"),
},
Name: pulumi.String("string"),
ObjectId: pulumi.String("string"),
Metadata: &ibm.OnboardingCatalogPlanMetadataArgs{
Other: &ibm.OnboardingCatalogPlanMetadataOtherArgs{
ResourceController: &ibm.OnboardingCatalogPlanMetadataOtherResourceControllerArgs{
SubscriptionProviderId: pulumi.String("string"),
},
},
Plan: &ibm.OnboardingCatalogPlanMetadataPlanArgs{
AllowInternalUsers: pulumi.Bool(false),
Bindable: pulumi.Bool(false),
ProvisionType: pulumi.String("string"),
Reservable: pulumi.Bool(false),
},
Pricing: &ibm.OnboardingCatalogPlanMetadataPricingArgs{
Origin: pulumi.String("string"),
SalesAvenues: pulumi.StringArray{
pulumi.String("string"),
},
Type: pulumi.String("string"),
},
RcCompatible: pulumi.Bool(false),
Service: &ibm.OnboardingCatalogPlanMetadataServiceArgs{
Bindable: pulumi.Bool(false),
IamCompatible: pulumi.Bool(false),
PlanUpdateable: pulumi.Bool(false),
RcProvisionable: pulumi.Bool(false),
ServiceKeySupported: pulumi.Bool(false),
UniqueApiKey: pulumi.Bool(false),
},
Ui: &ibm.OnboardingCatalogPlanMetadataUiArgs{
Hidden: pulumi.Bool(false),
SideBySideIndex: pulumi.Float64(0),
Strings: &ibm.OnboardingCatalogPlanMetadataUiStringsArgs{
En: &ibm.OnboardingCatalogPlanMetadataUiStringsEnArgs{
Bullets: ibm.OnboardingCatalogPlanMetadataUiStringsEnBulletArray{
&ibm.OnboardingCatalogPlanMetadataUiStringsEnBulletArgs{
Description: pulumi.String("string"),
Title: pulumi.String("string"),
},
},
Media: ibm.OnboardingCatalogPlanMetadataUiStringsEnMediaArray{
&ibm.OnboardingCatalogPlanMetadataUiStringsEnMediaArgs{
Caption: pulumi.String("string"),
Type: pulumi.String("string"),
Url: pulumi.String("string"),
Thumbnail: pulumi.String("string"),
},
},
NavigationItems: ibm.OnboardingCatalogPlanMetadataUiStringsEnNavigationItemArray{
&ibm.OnboardingCatalogPlanMetadataUiStringsEnNavigationItemArgs{
Id: pulumi.String("string"),
Label: pulumi.String("string"),
Url: pulumi.String("string"),
},
},
},
},
Urls: &ibm.OnboardingCatalogPlanMetadataUiUrlsArgs{
ApidocsUrl: pulumi.String("string"),
CatalogDetailsUrl: pulumi.String("string"),
CustomCreatePageUrl: pulumi.String("string"),
Dashboard: pulumi.String("string"),
DocUrl: pulumi.String("string"),
InstructionsUrl: pulumi.String("string"),
TermsUrl: pulumi.String("string"),
},
},
},
OnboardingCatalogPlanId: pulumi.String("string"),
OverviewUi: &ibm.OnboardingCatalogPlanOverviewUiArgs{
En: &ibm.OnboardingCatalogPlanOverviewUiEnArgs{
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
LongDescription: pulumi.String("string"),
},
},
PricingTags: pulumi.StringArray{
pulumi.String("string"),
},
Env: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})
var onboardingCatalogPlanResource = new OnboardingCatalogPlan("onboardingCatalogPlanResource", OnboardingCatalogPlanArgs.builder()
.active(false)
.catalogProductId("string")
.disabled(false)
.productId("string")
.kind("string")
.objectProvider(OnboardingCatalogPlanObjectProviderArgs.builder()
.email("string")
.name("string")
.build())
.name("string")
.objectId("string")
.metadata(OnboardingCatalogPlanMetadataArgs.builder()
.other(OnboardingCatalogPlanMetadataOtherArgs.builder()
.resourceController(OnboardingCatalogPlanMetadataOtherResourceControllerArgs.builder()
.subscriptionProviderId("string")
.build())
.build())
.plan(OnboardingCatalogPlanMetadataPlanArgs.builder()
.allowInternalUsers(false)
.bindable(false)
.provisionType("string")
.reservable(false)
.build())
.pricing(OnboardingCatalogPlanMetadataPricingArgs.builder()
.origin("string")
.salesAvenues("string")
.type("string")
.build())
.rcCompatible(false)
.service(OnboardingCatalogPlanMetadataServiceArgs.builder()
.bindable(false)
.iamCompatible(false)
.planUpdateable(false)
.rcProvisionable(false)
.serviceKeySupported(false)
.uniqueApiKey(false)
.build())
.ui(OnboardingCatalogPlanMetadataUiArgs.builder()
.hidden(false)
.sideBySideIndex(0)
.strings(OnboardingCatalogPlanMetadataUiStringsArgs.builder()
.en(OnboardingCatalogPlanMetadataUiStringsEnArgs.builder()
.bullets(OnboardingCatalogPlanMetadataUiStringsEnBulletArgs.builder()
.description("string")
.title("string")
.build())
.media(OnboardingCatalogPlanMetadataUiStringsEnMediaArgs.builder()
.caption("string")
.type("string")
.url("string")
.thumbnail("string")
.build())
.navigationItems(OnboardingCatalogPlanMetadataUiStringsEnNavigationItemArgs.builder()
.id("string")
.label("string")
.url("string")
.build())
.build())
.build())
.urls(OnboardingCatalogPlanMetadataUiUrlsArgs.builder()
.apidocsUrl("string")
.catalogDetailsUrl("string")
.customCreatePageUrl("string")
.dashboard("string")
.docUrl("string")
.instructionsUrl("string")
.termsUrl("string")
.build())
.build())
.build())
.onboardingCatalogPlanId("string")
.overviewUi(OnboardingCatalogPlanOverviewUiArgs.builder()
.en(OnboardingCatalogPlanOverviewUiEnArgs.builder()
.description("string")
.displayName("string")
.longDescription("string")
.build())
.build())
.pricingTags("string")
.env("string")
.tags("string")
.build());
onboarding_catalog_plan_resource = ibm.OnboardingCatalogPlan("onboardingCatalogPlanResource",
active=False,
catalog_product_id="string",
disabled=False,
product_id="string",
kind="string",
object_provider={
"email": "string",
"name": "string",
},
name="string",
object_id="string",
metadata={
"other": {
"resource_controller": {
"subscription_provider_id": "string",
},
},
"plan": {
"allow_internal_users": False,
"bindable": False,
"provision_type": "string",
"reservable": False,
},
"pricing": {
"origin": "string",
"sales_avenues": ["string"],
"type": "string",
},
"rc_compatible": False,
"service": {
"bindable": False,
"iam_compatible": False,
"plan_updateable": False,
"rc_provisionable": False,
"service_key_supported": False,
"unique_api_key": False,
},
"ui": {
"hidden": False,
"side_by_side_index": 0,
"strings": {
"en": {
"bullets": [{
"description": "string",
"title": "string",
}],
"media": [{
"caption": "string",
"type": "string",
"url": "string",
"thumbnail": "string",
}],
"navigation_items": [{
"id": "string",
"label": "string",
"url": "string",
}],
},
},
"urls": {
"apidocs_url": "string",
"catalog_details_url": "string",
"custom_create_page_url": "string",
"dashboard": "string",
"doc_url": "string",
"instructions_url": "string",
"terms_url": "string",
},
},
},
onboarding_catalog_plan_id="string",
overview_ui={
"en": {
"description": "string",
"display_name": "string",
"long_description": "string",
},
},
pricing_tags=["string"],
env="string",
tags=["string"])
const onboardingCatalogPlanResource = new ibm.OnboardingCatalogPlan("onboardingCatalogPlanResource", {
active: false,
catalogProductId: "string",
disabled: false,
productId: "string",
kind: "string",
objectProvider: {
email: "string",
name: "string",
},
name: "string",
objectId: "string",
metadata: {
other: {
resourceController: {
subscriptionProviderId: "string",
},
},
plan: {
allowInternalUsers: false,
bindable: false,
provisionType: "string",
reservable: false,
},
pricing: {
origin: "string",
salesAvenues: ["string"],
type: "string",
},
rcCompatible: false,
service: {
bindable: false,
iamCompatible: false,
planUpdateable: false,
rcProvisionable: false,
serviceKeySupported: false,
uniqueApiKey: false,
},
ui: {
hidden: false,
sideBySideIndex: 0,
strings: {
en: {
bullets: [{
description: "string",
title: "string",
}],
media: [{
caption: "string",
type: "string",
url: "string",
thumbnail: "string",
}],
navigationItems: [{
id: "string",
label: "string",
url: "string",
}],
},
},
urls: {
apidocsUrl: "string",
catalogDetailsUrl: "string",
customCreatePageUrl: "string",
dashboard: "string",
docUrl: "string",
instructionsUrl: "string",
termsUrl: "string",
},
},
},
onboardingCatalogPlanId: "string",
overviewUi: {
en: {
description: "string",
displayName: "string",
longDescription: "string",
},
},
pricingTags: ["string"],
env: "string",
tags: ["string"],
});
type: ibm:OnboardingCatalogPlan
properties:
active: false
catalogProductId: string
disabled: false
env: string
kind: string
metadata:
other:
resourceController:
subscriptionProviderId: string
plan:
allowInternalUsers: false
bindable: false
provisionType: string
reservable: false
pricing:
origin: string
salesAvenues:
- string
type: string
rcCompatible: false
service:
bindable: false
iamCompatible: false
planUpdateable: false
rcProvisionable: false
serviceKeySupported: false
uniqueApiKey: false
ui:
hidden: false
sideBySideIndex: 0
strings:
en:
bullets:
- description: string
title: string
media:
- caption: string
thumbnail: string
type: string
url: string
navigationItems:
- id: string
label: string
url: string
urls:
apidocsUrl: string
catalogDetailsUrl: string
customCreatePageUrl: string
dashboard: string
docUrl: string
instructionsUrl: string
termsUrl: string
name: string
objectId: string
objectProvider:
email: string
name: string
onboardingCatalogPlanId: string
overviewUi:
en:
description: string
displayName: string
longDescription: string
pricingTags:
- string
productId: string
tags:
- string
OnboardingCatalogPlan Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The OnboardingCatalogPlan resource accepts the following input properties:
- Active bool
- Whether the service is active.
- Catalog
Product stringId - The unique ID of this global catalog product.
- Constraints: The maximum length is
128characters. The minimum length is1character. The value must match regular expression/^\\S*$/.
- Constraints: The maximum length is
- Disabled bool
- Determines the global visibility for the catalog entry, and its children. If it is not enabled, all plans are disabled.
- Kind string
- The kind of the global catalog object.
- Constraints: Allowable values are:
plan.
- Constraints: Allowable values are:
- Object
Provider OnboardingCatalog Plan Object Provider - The provider or owner of the product. Nested schema for object_provider:
- Product
Id string - The unique ID of the product.
- Constraints: The maximum length is
71characters. The minimum length is71characters. The value must match regular expression/^[a-zA-Z0-9]{32}:o:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.
- Constraints: The maximum length is
- Env string
- The environment to fetch this object from.
- Constraints: The maximum length is
64characters. The minimum length is1character. The value must match regular expression/^[a-z_.-]+$/.
- Constraints: The maximum length is
- Metadata
Onboarding
Catalog Plan Metadata - Global catalog plan metadata. Nested schema for metadata:
- Name string
- The programmatic name of this plan.
- Constraints: The value must match regular expression
/^\\S*$/.
- Constraints: The value must match regular expression
- Object
Id string - The desired ID of the global catalog object.
- Onboarding
Catalog stringPlan Id - The unique identifier of the onboarding_catalog_plan.
- Overview
Ui OnboardingCatalog Plan Overview Ui - The object that contains the service details from the Overview page in global catalog. Nested schema for overview_ui:
- List<string>
- A list of tags that carry information about the pricing information of your product.
- Constraints: The list items must match regular expression
/^[a-z0-9\\-._]+$/. The maximum length is100items. The minimum length is0items.
- Constraints: The list items must match regular expression
- List<string>
- A list of tags that carry information about your product. These tags can be used to find your product in the IBM Cloud catalog.
- Constraints: The list items must match regular expression
/^[a-z0-9\\-._]+$/. The maximum length is100items. The minimum length is0items.
- Constraints: The list items must match regular expression
- Active bool
- Whether the service is active.
- Catalog
Product stringId - The unique ID of this global catalog product.
- Constraints: The maximum length is
128characters. The minimum length is1character. The value must match regular expression/^\\S*$/.
- Constraints: The maximum length is
- Disabled bool
- Determines the global visibility for the catalog entry, and its children. If it is not enabled, all plans are disabled.
- Kind string
- The kind of the global catalog object.
- Constraints: Allowable values are:
plan.
- Constraints: Allowable values are:
- Object
Provider OnboardingCatalog Plan Object Provider Args - The provider or owner of the product. Nested schema for object_provider:
- Product
Id string - The unique ID of the product.
- Constraints: The maximum length is
71characters. The minimum length is71characters. The value must match regular expression/^[a-zA-Z0-9]{32}:o:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.
- Constraints: The maximum length is
- Env string
- The environment to fetch this object from.
- Constraints: The maximum length is
64characters. The minimum length is1character. The value must match regular expression/^[a-z_.-]+$/.
- Constraints: The maximum length is
- Metadata
Onboarding
Catalog Plan Metadata Args - Global catalog plan metadata. Nested schema for metadata:
- Name string
- The programmatic name of this plan.
- Constraints: The value must match regular expression
/^\\S*$/.
- Constraints: The value must match regular expression
- Object
Id string - The desired ID of the global catalog object.
- Onboarding
Catalog stringPlan Id - The unique identifier of the onboarding_catalog_plan.
- Overview
Ui OnboardingCatalog Plan Overview Ui Args - The object that contains the service details from the Overview page in global catalog. Nested schema for overview_ui:
- []string
- A list of tags that carry information about the pricing information of your product.
- Constraints: The list items must match regular expression
/^[a-z0-9\\-._]+$/. The maximum length is100items. The minimum length is0items.
- Constraints: The list items must match regular expression
- []string
- A list of tags that carry information about your product. These tags can be used to find your product in the IBM Cloud catalog.
- Constraints: The list items must match regular expression
/^[a-z0-9\\-._]+$/. The maximum length is100items. The minimum length is0items.
- Constraints: The list items must match regular expression
- active Boolean
- Whether the service is active.
- catalog
Product StringId - The unique ID of this global catalog product.
- Constraints: The maximum length is
128characters. The minimum length is1character. The value must match regular expression/^\\S*$/.
- Constraints: The maximum length is
- disabled Boolean
- Determines the global visibility for the catalog entry, and its children. If it is not enabled, all plans are disabled.
- kind String
- The kind of the global catalog object.
- Constraints: Allowable values are:
plan.
- Constraints: Allowable values are:
- object
Provider OnboardingCatalog Plan Object Provider - The provider or owner of the product. Nested schema for object_provider:
- product
Id String - The unique ID of the product.
- Constraints: The maximum length is
71characters. The minimum length is71characters. The value must match regular expression/^[a-zA-Z0-9]{32}:o:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.
- Constraints: The maximum length is
- env String
- The environment to fetch this object from.
- Constraints: The maximum length is
64characters. The minimum length is1character. The value must match regular expression/^[a-z_.-]+$/.
- Constraints: The maximum length is
- metadata
Onboarding
Catalog Plan Metadata - Global catalog plan metadata. Nested schema for metadata:
- name String
- The programmatic name of this plan.
- Constraints: The value must match regular expression
/^\\S*$/.
- Constraints: The value must match regular expression
- object
Id String - The desired ID of the global catalog object.
- onboarding
Catalog StringPlan Id - The unique identifier of the onboarding_catalog_plan.
- overview
Ui OnboardingCatalog Plan Overview Ui - The object that contains the service details from the Overview page in global catalog. Nested schema for overview_ui:
- List<String>
- A list of tags that carry information about the pricing information of your product.
- Constraints: The list items must match regular expression
/^[a-z0-9\\-._]+$/. The maximum length is100items. The minimum length is0items.
- Constraints: The list items must match regular expression
- List<String>
- A list of tags that carry information about your product. These tags can be used to find your product in the IBM Cloud catalog.
- Constraints: The list items must match regular expression
/^[a-z0-9\\-._]+$/. The maximum length is100items. The minimum length is0items.
- Constraints: The list items must match regular expression
- active boolean
- Whether the service is active.
- catalog
Product stringId - The unique ID of this global catalog product.
- Constraints: The maximum length is
128characters. The minimum length is1character. The value must match regular expression/^\\S*$/.
- Constraints: The maximum length is
- disabled boolean
- Determines the global visibility for the catalog entry, and its children. If it is not enabled, all plans are disabled.
- kind string
- The kind of the global catalog object.
- Constraints: Allowable values are:
plan.
- Constraints: Allowable values are:
- object
Provider OnboardingCatalog Plan Object Provider - The provider or owner of the product. Nested schema for object_provider:
- product
Id string - The unique ID of the product.
- Constraints: The maximum length is
71characters. The minimum length is71characters. The value must match regular expression/^[a-zA-Z0-9]{32}:o:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.
- Constraints: The maximum length is
- env string
- The environment to fetch this object from.
- Constraints: The maximum length is
64characters. The minimum length is1character. The value must match regular expression/^[a-z_.-]+$/.
- Constraints: The maximum length is
- metadata
Onboarding
Catalog Plan Metadata - Global catalog plan metadata. Nested schema for metadata:
- name string
- The programmatic name of this plan.
- Constraints: The value must match regular expression
/^\\S*$/.
- Constraints: The value must match regular expression
- object
Id string - The desired ID of the global catalog object.
- onboarding
Catalog stringPlan Id - The unique identifier of the onboarding_catalog_plan.
- overview
Ui OnboardingCatalog Plan Overview Ui - The object that contains the service details from the Overview page in global catalog. Nested schema for overview_ui:
- string[]
- A list of tags that carry information about the pricing information of your product.
- Constraints: The list items must match regular expression
/^[a-z0-9\\-._]+$/. The maximum length is100items. The minimum length is0items.
- Constraints: The list items must match regular expression
- string[]
- A list of tags that carry information about your product. These tags can be used to find your product in the IBM Cloud catalog.
- Constraints: The list items must match regular expression
/^[a-z0-9\\-._]+$/. The maximum length is100items. The minimum length is0items.
- Constraints: The list items must match regular expression
- active bool
- Whether the service is active.
- catalog_
product_ strid - The unique ID of this global catalog product.
- Constraints: The maximum length is
128characters. The minimum length is1character. The value must match regular expression/^\\S*$/.
- Constraints: The maximum length is
- disabled bool
- Determines the global visibility for the catalog entry, and its children. If it is not enabled, all plans are disabled.
- kind str
- The kind of the global catalog object.
- Constraints: Allowable values are:
plan.
- Constraints: Allowable values are:
- object_
provider OnboardingCatalog Plan Object Provider Args - The provider or owner of the product. Nested schema for object_provider:
- product_
id str - The unique ID of the product.
- Constraints: The maximum length is
71characters. The minimum length is71characters. The value must match regular expression/^[a-zA-Z0-9]{32}:o:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.
- Constraints: The maximum length is
- env str
- The environment to fetch this object from.
- Constraints: The maximum length is
64characters. The minimum length is1character. The value must match regular expression/^[a-z_.-]+$/.
- Constraints: The maximum length is
- metadata
Onboarding
Catalog Plan Metadata Args - Global catalog plan metadata. Nested schema for metadata:
- name str
- The programmatic name of this plan.
- Constraints: The value must match regular expression
/^\\S*$/.
- Constraints: The value must match regular expression
- object_
id str - The desired ID of the global catalog object.
- onboarding_
catalog_ strplan_ id - The unique identifier of the onboarding_catalog_plan.
- overview_
ui OnboardingCatalog Plan Overview Ui Args - The object that contains the service details from the Overview page in global catalog. Nested schema for overview_ui:
- Sequence[str]
- A list of tags that carry information about the pricing information of your product.
- Constraints: The list items must match regular expression
/^[a-z0-9\\-._]+$/. The maximum length is100items. The minimum length is0items.
- Constraints: The list items must match regular expression
- Sequence[str]
- A list of tags that carry information about your product. These tags can be used to find your product in the IBM Cloud catalog.
- Constraints: The list items must match regular expression
/^[a-z0-9\\-._]+$/. The maximum length is100items. The minimum length is0items.
- Constraints: The list items must match regular expression
- active Boolean
- Whether the service is active.
- catalog
Product StringId - The unique ID of this global catalog product.
- Constraints: The maximum length is
128characters. The minimum length is1character. The value must match regular expression/^\\S*$/.
- Constraints: The maximum length is
- disabled Boolean
- Determines the global visibility for the catalog entry, and its children. If it is not enabled, all plans are disabled.
- kind String
- The kind of the global catalog object.
- Constraints: Allowable values are:
plan.
- Constraints: Allowable values are:
- object
Provider Property Map - The provider or owner of the product. Nested schema for object_provider:
- product
Id String - The unique ID of the product.
- Constraints: The maximum length is
71characters. The minimum length is71characters. The value must match regular expression/^[a-zA-Z0-9]{32}:o:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.
- Constraints: The maximum length is
- env String
- The environment to fetch this object from.
- Constraints: The maximum length is
64characters. The minimum length is1character. The value must match regular expression/^[a-z_.-]+$/.
- Constraints: The maximum length is
- metadata Property Map
- Global catalog plan metadata. Nested schema for metadata:
- name String
- The programmatic name of this plan.
- Constraints: The value must match regular expression
/^\\S*$/.
- Constraints: The value must match regular expression
- object
Id String - The desired ID of the global catalog object.
- onboarding
Catalog StringPlan Id - The unique identifier of the onboarding_catalog_plan.
- overview
Ui Property Map - The object that contains the service details from the Overview page in global catalog. Nested schema for overview_ui:
- List<String>
- A list of tags that carry information about the pricing information of your product.
- Constraints: The list items must match regular expression
/^[a-z0-9\\-._]+$/. The maximum length is100items. The minimum length is0items.
- Constraints: The list items must match regular expression
- List<String>
- A list of tags that carry information about your product. These tags can be used to find your product in the IBM Cloud catalog.
- Constraints: The list items must match regular expression
/^[a-z0-9\\-._]+$/. The maximum length is100items. The minimum length is0items.
- Constraints: The list items must match regular expression
Outputs
All input properties are implicitly available as output properties. Additionally, the OnboardingCatalogPlan resource produces the following output properties:
- Catalog
Plan stringId - (String) The ID of a global catalog object.
- Constraints: The value must match regular expression
/^\\S*$/.
- Constraints: The value must match regular expression
- List<string>
- (List)
- Constraints: The list items must match regular expression
/./. The maximum length is1000items. The minimum length is0items.
- Constraints: The list items must match regular expression
- Id string
- The provider-assigned unique ID for this managed resource.
- Url string
- (String) The global catalog URL of your product.
- Catalog
Plan stringId - (String) The ID of a global catalog object.
- Constraints: The value must match regular expression
/^\\S*$/.
- Constraints: The value must match regular expression
- []string
- (List)
- Constraints: The list items must match regular expression
/./. The maximum length is1000items. The minimum length is0items.
- Constraints: The list items must match regular expression
- Id string
- The provider-assigned unique ID for this managed resource.
- Url string
- (String) The global catalog URL of your product.
- catalog
Plan StringId - (String) The ID of a global catalog object.
- Constraints: The value must match regular expression
/^\\S*$/.
- Constraints: The value must match regular expression
- List<String>
- (List)
- Constraints: The list items must match regular expression
/./. The maximum length is1000items. The minimum length is0items.
- Constraints: The list items must match regular expression
- id String
- The provider-assigned unique ID for this managed resource.
- url String
- (String) The global catalog URL of your product.
- catalog
Plan stringId - (String) The ID of a global catalog object.
- Constraints: The value must match regular expression
/^\\S*$/.
- Constraints: The value must match regular expression
- string[]
- (List)
- Constraints: The list items must match regular expression
/./. The maximum length is1000items. The minimum length is0items.
- Constraints: The list items must match regular expression
- id string
- The provider-assigned unique ID for this managed resource.
- url string
- (String) The global catalog URL of your product.
- catalog_
plan_ strid - (String) The ID of a global catalog object.
- Constraints: The value must match regular expression
/^\\S*$/.
- Constraints: The value must match regular expression
- Sequence[str]
- (List)
- Constraints: The list items must match regular expression
/./. The maximum length is1000items. The minimum length is0items.
- Constraints: The list items must match regular expression
- id str
- The provider-assigned unique ID for this managed resource.
- url str
- (String) The global catalog URL of your product.
- catalog
Plan StringId - (String) The ID of a global catalog object.
- Constraints: The value must match regular expression
/^\\S*$/.
- Constraints: The value must match regular expression
- List<String>
- (List)
- Constraints: The list items must match regular expression
/./. The maximum length is1000items. The minimum length is0items.
- Constraints: The list items must match regular expression
- id String
- The provider-assigned unique ID for this managed resource.
- url String
- (String) The global catalog URL of your product.
Look up Existing OnboardingCatalogPlan Resource
Get an existing OnboardingCatalogPlan 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?: OnboardingCatalogPlanState, opts?: CustomResourceOptions): OnboardingCatalogPlan@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
active: Optional[bool] = None,
catalog_plan_id: Optional[str] = None,
catalog_product_id: Optional[str] = None,
disabled: Optional[bool] = None,
env: Optional[str] = None,
geo_tags: Optional[Sequence[str]] = None,
kind: Optional[str] = None,
metadata: Optional[OnboardingCatalogPlanMetadataArgs] = None,
name: Optional[str] = None,
object_id: Optional[str] = None,
object_provider: Optional[OnboardingCatalogPlanObjectProviderArgs] = None,
onboarding_catalog_plan_id: Optional[str] = None,
overview_ui: Optional[OnboardingCatalogPlanOverviewUiArgs] = None,
pricing_tags: Optional[Sequence[str]] = None,
product_id: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
url: Optional[str] = None) -> OnboardingCatalogPlanfunc GetOnboardingCatalogPlan(ctx *Context, name string, id IDInput, state *OnboardingCatalogPlanState, opts ...ResourceOption) (*OnboardingCatalogPlan, error)public static OnboardingCatalogPlan Get(string name, Input<string> id, OnboardingCatalogPlanState? state, CustomResourceOptions? opts = null)public static OnboardingCatalogPlan get(String name, Output<String> id, OnboardingCatalogPlanState state, CustomResourceOptions options)resources: _: type: ibm:OnboardingCatalogPlan get: id: ${id}- 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.
- Active bool
- Whether the service is active.
- Catalog
Plan stringId - (String) The ID of a global catalog object.
- Constraints: The value must match regular expression
/^\\S*$/.
- Constraints: The value must match regular expression
- Catalog
Product stringId - The unique ID of this global catalog product.
- Constraints: The maximum length is
128characters. The minimum length is1character. The value must match regular expression/^\\S*$/.
- Constraints: The maximum length is
- Disabled bool
- Determines the global visibility for the catalog entry, and its children. If it is not enabled, all plans are disabled.
- Env string
- The environment to fetch this object from.
- Constraints: The maximum length is
64characters. The minimum length is1character. The value must match regular expression/^[a-z_.-]+$/.
- Constraints: The maximum length is
- List<string>
- (List)
- Constraints: The list items must match regular expression
/./. The maximum length is1000items. The minimum length is0items.
- Constraints: The list items must match regular expression
- Kind string
- The kind of the global catalog object.
- Constraints: Allowable values are:
plan.
- Constraints: Allowable values are:
- Metadata
Onboarding
Catalog Plan Metadata - Global catalog plan metadata. Nested schema for metadata:
- Name string
- The programmatic name of this plan.
- Constraints: The value must match regular expression
/^\\S*$/.
- Constraints: The value must match regular expression
- Object
Id string - The desired ID of the global catalog object.
- Object
Provider OnboardingCatalog Plan Object Provider - The provider or owner of the product. Nested schema for object_provider:
- Onboarding
Catalog stringPlan Id - The unique identifier of the onboarding_catalog_plan.
- Overview
Ui OnboardingCatalog Plan Overview Ui - The object that contains the service details from the Overview page in global catalog. Nested schema for overview_ui:
- List<string>
- A list of tags that carry information about the pricing information of your product.
- Constraints: The list items must match regular expression
/^[a-z0-9\\-._]+$/. The maximum length is100items. The minimum length is0items.
- Constraints: The list items must match regular expression
- Product
Id string - The unique ID of the product.
- Constraints: The maximum length is
71characters. The minimum length is71characters. The value must match regular expression/^[a-zA-Z0-9]{32}:o:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.
- Constraints: The maximum length is
- List<string>
- A list of tags that carry information about your product. These tags can be used to find your product in the IBM Cloud catalog.
- Constraints: The list items must match regular expression
/^[a-z0-9\\-._]+$/. The maximum length is100items. The minimum length is0items.
- Constraints: The list items must match regular expression
- Url string
- (String) The global catalog URL of your product.
- Active bool
- Whether the service is active.
- Catalog
Plan stringId - (String) The ID of a global catalog object.
- Constraints: The value must match regular expression
/^\\S*$/.
- Constraints: The value must match regular expression
- Catalog
Product stringId - The unique ID of this global catalog product.
- Constraints: The maximum length is
128characters. The minimum length is1character. The value must match regular expression/^\\S*$/.
- Constraints: The maximum length is
- Disabled bool
- Determines the global visibility for the catalog entry, and its children. If it is not enabled, all plans are disabled.
- Env string
- The environment to fetch this object from.
- Constraints: The maximum length is
64characters. The minimum length is1character. The value must match regular expression/^[a-z_.-]+$/.
- Constraints: The maximum length is
- []string
- (List)
- Constraints: The list items must match regular expression
/./. The maximum length is1000items. The minimum length is0items.
- Constraints: The list items must match regular expression
- Kind string
- The kind of the global catalog object.
- Constraints: Allowable values are:
plan.
- Constraints: Allowable values are:
- Metadata
Onboarding
Catalog Plan Metadata Args - Global catalog plan metadata. Nested schema for metadata:
- Name string
- The programmatic name of this plan.
- Constraints: The value must match regular expression
/^\\S*$/.
- Constraints: The value must match regular expression
- Object
Id string - The desired ID of the global catalog object.
- Object
Provider OnboardingCatalog Plan Object Provider Args - The provider or owner of the product. Nested schema for object_provider:
- Onboarding
Catalog stringPlan Id - The unique identifier of the onboarding_catalog_plan.
- Overview
Ui OnboardingCatalog Plan Overview Ui Args - The object that contains the service details from the Overview page in global catalog. Nested schema for overview_ui:
- []string
- A list of tags that carry information about the pricing information of your product.
- Constraints: The list items must match regular expression
/^[a-z0-9\\-._]+$/. The maximum length is100items. The minimum length is0items.
- Constraints: The list items must match regular expression
- Product
Id string - The unique ID of the product.
- Constraints: The maximum length is
71characters. The minimum length is71characters. The value must match regular expression/^[a-zA-Z0-9]{32}:o:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.
- Constraints: The maximum length is
- []string
- A list of tags that carry information about your product. These tags can be used to find your product in the IBM Cloud catalog.
- Constraints: The list items must match regular expression
/^[a-z0-9\\-._]+$/. The maximum length is100items. The minimum length is0items.
- Constraints: The list items must match regular expression
- Url string
- (String) The global catalog URL of your product.
- active Boolean
- Whether the service is active.
- catalog
Plan StringId - (String) The ID of a global catalog object.
- Constraints: The value must match regular expression
/^\\S*$/.
- Constraints: The value must match regular expression
- catalog
Product StringId - The unique ID of this global catalog product.
- Constraints: The maximum length is
128characters. The minimum length is1character. The value must match regular expression/^\\S*$/.
- Constraints: The maximum length is
- disabled Boolean
- Determines the global visibility for the catalog entry, and its children. If it is not enabled, all plans are disabled.
- env String
- The environment to fetch this object from.
- Constraints: The maximum length is
64characters. The minimum length is1character. The value must match regular expression/^[a-z_.-]+$/.
- Constraints: The maximum length is
- List<String>
- (List)
- Constraints: The list items must match regular expression
/./. The maximum length is1000items. The minimum length is0items.
- Constraints: The list items must match regular expression
- kind String
- The kind of the global catalog object.
- Constraints: Allowable values are:
plan.
- Constraints: Allowable values are:
- metadata
Onboarding
Catalog Plan Metadata - Global catalog plan metadata. Nested schema for metadata:
- name String
- The programmatic name of this plan.
- Constraints: The value must match regular expression
/^\\S*$/.
- Constraints: The value must match regular expression
- object
Id String - The desired ID of the global catalog object.
- object
Provider OnboardingCatalog Plan Object Provider - The provider or owner of the product. Nested schema for object_provider:
- onboarding
Catalog StringPlan Id - The unique identifier of the onboarding_catalog_plan.
- overview
Ui OnboardingCatalog Plan Overview Ui - The object that contains the service details from the Overview page in global catalog. Nested schema for overview_ui:
- List<String>
- A list of tags that carry information about the pricing information of your product.
- Constraints: The list items must match regular expression
/^[a-z0-9\\-._]+$/. The maximum length is100items. The minimum length is0items.
- Constraints: The list items must match regular expression
- product
Id String - The unique ID of the product.
- Constraints: The maximum length is
71characters. The minimum length is71characters. The value must match regular expression/^[a-zA-Z0-9]{32}:o:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.
- Constraints: The maximum length is
- List<String>
- A list of tags that carry information about your product. These tags can be used to find your product in the IBM Cloud catalog.
- Constraints: The list items must match regular expression
/^[a-z0-9\\-._]+$/. The maximum length is100items. The minimum length is0items.
- Constraints: The list items must match regular expression
- url String
- (String) The global catalog URL of your product.
- active boolean
- Whether the service is active.
- catalog
Plan stringId - (String) The ID of a global catalog object.
- Constraints: The value must match regular expression
/^\\S*$/.
- Constraints: The value must match regular expression
- catalog
Product stringId - The unique ID of this global catalog product.
- Constraints: The maximum length is
128characters. The minimum length is1character. The value must match regular expression/^\\S*$/.
- Constraints: The maximum length is
- disabled boolean
- Determines the global visibility for the catalog entry, and its children. If it is not enabled, all plans are disabled.
- env string
- The environment to fetch this object from.
- Constraints: The maximum length is
64characters. The minimum length is1character. The value must match regular expression/^[a-z_.-]+$/.
- Constraints: The maximum length is
- string[]
- (List)
- Constraints: The list items must match regular expression
/./. The maximum length is1000items. The minimum length is0items.
- Constraints: The list items must match regular expression
- kind string
- The kind of the global catalog object.
- Constraints: Allowable values are:
plan.
- Constraints: Allowable values are:
- metadata
Onboarding
Catalog Plan Metadata - Global catalog plan metadata. Nested schema for metadata:
- name string
- The programmatic name of this plan.
- Constraints: The value must match regular expression
/^\\S*$/.
- Constraints: The value must match regular expression
- object
Id string - The desired ID of the global catalog object.
- object
Provider OnboardingCatalog Plan Object Provider - The provider or owner of the product. Nested schema for object_provider:
- onboarding
Catalog stringPlan Id - The unique identifier of the onboarding_catalog_plan.
- overview
Ui OnboardingCatalog Plan Overview Ui - The object that contains the service details from the Overview page in global catalog. Nested schema for overview_ui:
- string[]
- A list of tags that carry information about the pricing information of your product.
- Constraints: The list items must match regular expression
/^[a-z0-9\\-._]+$/. The maximum length is100items. The minimum length is0items.
- Constraints: The list items must match regular expression
- product
Id string - The unique ID of the product.
- Constraints: The maximum length is
71characters. The minimum length is71characters. The value must match regular expression/^[a-zA-Z0-9]{32}:o:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.
- Constraints: The maximum length is
- string[]
- A list of tags that carry information about your product. These tags can be used to find your product in the IBM Cloud catalog.
- Constraints: The list items must match regular expression
/^[a-z0-9\\-._]+$/. The maximum length is100items. The minimum length is0items.
- Constraints: The list items must match regular expression
- url string
- (String) The global catalog URL of your product.
- active bool
- Whether the service is active.
- catalog_
plan_ strid - (String) The ID of a global catalog object.
- Constraints: The value must match regular expression
/^\\S*$/.
- Constraints: The value must match regular expression
- catalog_
product_ strid - The unique ID of this global catalog product.
- Constraints: The maximum length is
128characters. The minimum length is1character. The value must match regular expression/^\\S*$/.
- Constraints: The maximum length is
- disabled bool
- Determines the global visibility for the catalog entry, and its children. If it is not enabled, all plans are disabled.
- env str
- The environment to fetch this object from.
- Constraints: The maximum length is
64characters. The minimum length is1character. The value must match regular expression/^[a-z_.-]+$/.
- Constraints: The maximum length is
- Sequence[str]
- (List)
- Constraints: The list items must match regular expression
/./. The maximum length is1000items. The minimum length is0items.
- Constraints: The list items must match regular expression
- kind str
- The kind of the global catalog object.
- Constraints: Allowable values are:
plan.
- Constraints: Allowable values are:
- metadata
Onboarding
Catalog Plan Metadata Args - Global catalog plan metadata. Nested schema for metadata:
- name str
- The programmatic name of this plan.
- Constraints: The value must match regular expression
/^\\S*$/.
- Constraints: The value must match regular expression
- object_
id str - The desired ID of the global catalog object.
- object_
provider OnboardingCatalog Plan Object Provider Args - The provider or owner of the product. Nested schema for object_provider:
- onboarding_
catalog_ strplan_ id - The unique identifier of the onboarding_catalog_plan.
- overview_
ui OnboardingCatalog Plan Overview Ui Args - The object that contains the service details from the Overview page in global catalog. Nested schema for overview_ui:
- Sequence[str]
- A list of tags that carry information about the pricing information of your product.
- Constraints: The list items must match regular expression
/^[a-z0-9\\-._]+$/. The maximum length is100items. The minimum length is0items.
- Constraints: The list items must match regular expression
- product_
id str - The unique ID of the product.
- Constraints: The maximum length is
71characters. The minimum length is71characters. The value must match regular expression/^[a-zA-Z0-9]{32}:o:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.
- Constraints: The maximum length is
- Sequence[str]
- A list of tags that carry information about your product. These tags can be used to find your product in the IBM Cloud catalog.
- Constraints: The list items must match regular expression
/^[a-z0-9\\-._]+$/. The maximum length is100items. The minimum length is0items.
- Constraints: The list items must match regular expression
- url str
- (String) The global catalog URL of your product.
- active Boolean
- Whether the service is active.
- catalog
Plan StringId - (String) The ID of a global catalog object.
- Constraints: The value must match regular expression
/^\\S*$/.
- Constraints: The value must match regular expression
- catalog
Product StringId - The unique ID of this global catalog product.
- Constraints: The maximum length is
128characters. The minimum length is1character. The value must match regular expression/^\\S*$/.
- Constraints: The maximum length is
- disabled Boolean
- Determines the global visibility for the catalog entry, and its children. If it is not enabled, all plans are disabled.
- env String
- The environment to fetch this object from.
- Constraints: The maximum length is
64characters. The minimum length is1character. The value must match regular expression/^[a-z_.-]+$/.
- Constraints: The maximum length is
- List<String>
- (List)
- Constraints: The list items must match regular expression
/./. The maximum length is1000items. The minimum length is0items.
- Constraints: The list items must match regular expression
- kind String
- The kind of the global catalog object.
- Constraints: Allowable values are:
plan.
- Constraints: Allowable values are:
- metadata Property Map
- Global catalog plan metadata. Nested schema for metadata:
- name String
- The programmatic name of this plan.
- Constraints: The value must match regular expression
/^\\S*$/.
- Constraints: The value must match regular expression
- object
Id String - The desired ID of the global catalog object.
- object
Provider Property Map - The provider or owner of the product. Nested schema for object_provider:
- onboarding
Catalog StringPlan Id - The unique identifier of the onboarding_catalog_plan.
- overview
Ui Property Map - The object that contains the service details from the Overview page in global catalog. Nested schema for overview_ui:
- List<String>
- A list of tags that carry information about the pricing information of your product.
- Constraints: The list items must match regular expression
/^[a-z0-9\\-._]+$/. The maximum length is100items. The minimum length is0items.
- Constraints: The list items must match regular expression
- product
Id String - The unique ID of the product.
- Constraints: The maximum length is
71characters. The minimum length is71characters. The value must match regular expression/^[a-zA-Z0-9]{32}:o:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.
- Constraints: The maximum length is
- List<String>
- A list of tags that carry information about your product. These tags can be used to find your product in the IBM Cloud catalog.
- Constraints: The list items must match regular expression
/^[a-z0-9\\-._]+$/. The maximum length is100items. The minimum length is0items.
- Constraints: The list items must match regular expression
- url String
- (String) The global catalog URL of your product.
Supporting Types
OnboardingCatalogPlanMetadata, OnboardingCatalogPlanMetadataArgs
- Other
Onboarding
Catalog Plan Metadata Other - Global catalog plan metadata other field. Nested schema for other:
- Plan
Onboarding
Catalog Plan Metadata Plan - Metadata controlling Plan related settings. Nested schema for plan:
- Pricing
Onboarding
Catalog Plan Metadata Pricing - The pricing metadata of this object. Nested schema for pricing:
- Rc
Compatible bool - Whether the object is compatible with the resource controller service.
- Service
Onboarding
Catalog Plan Metadata Service - The global catalog metadata of the service. Nested schema for service:
- Ui
Onboarding
Catalog Plan Metadata Ui - The UI metadata of this service. Nested schema for ui:
- Other
Onboarding
Catalog Plan Metadata Other - Global catalog plan metadata other field. Nested schema for other:
- Plan
Onboarding
Catalog Plan Metadata Plan - Metadata controlling Plan related settings. Nested schema for plan:
- Pricing
Onboarding
Catalog Plan Metadata Pricing - The pricing metadata of this object. Nested schema for pricing:
- Rc
Compatible bool - Whether the object is compatible with the resource controller service.
- Service
Onboarding
Catalog Plan Metadata Service - The global catalog metadata of the service. Nested schema for service:
- Ui
Onboarding
Catalog Plan Metadata Ui - The UI metadata of this service. Nested schema for ui:
- other
Onboarding
Catalog Plan Metadata Other - Global catalog plan metadata other field. Nested schema for other:
- plan
Onboarding
Catalog Plan Metadata Plan - Metadata controlling Plan related settings. Nested schema for plan:
- pricing
Onboarding
Catalog Plan Metadata Pricing - The pricing metadata of this object. Nested schema for pricing:
- rc
Compatible Boolean - Whether the object is compatible with the resource controller service.
- service
Onboarding
Catalog Plan Metadata Service - The global catalog metadata of the service. Nested schema for service:
- ui
Onboarding
Catalog Plan Metadata Ui - The UI metadata of this service. Nested schema for ui:
- other
Onboarding
Catalog Plan Metadata Other - Global catalog plan metadata other field. Nested schema for other:
- plan
Onboarding
Catalog Plan Metadata Plan - Metadata controlling Plan related settings. Nested schema for plan:
- pricing
Onboarding
Catalog Plan Metadata Pricing - The pricing metadata of this object. Nested schema for pricing:
- rc
Compatible boolean - Whether the object is compatible with the resource controller service.
- service
Onboarding
Catalog Plan Metadata Service - The global catalog metadata of the service. Nested schema for service:
- ui
Onboarding
Catalog Plan Metadata Ui - The UI metadata of this service. Nested schema for ui:
- other
Onboarding
Catalog Plan Metadata Other - Global catalog plan metadata other field. Nested schema for other:
- plan
Onboarding
Catalog Plan Metadata Plan - Metadata controlling Plan related settings. Nested schema for plan:
- pricing
Onboarding
Catalog Plan Metadata Pricing - The pricing metadata of this object. Nested schema for pricing:
- rc_
compatible bool - Whether the object is compatible with the resource controller service.
- service
Onboarding
Catalog Plan Metadata Service - The global catalog metadata of the service. Nested schema for service:
- ui
Onboarding
Catalog Plan Metadata Ui - The UI metadata of this service. Nested schema for ui:
- other Property Map
- Global catalog plan metadata other field. Nested schema for other:
- plan Property Map
- Metadata controlling Plan related settings. Nested schema for plan:
- pricing Property Map
- The pricing metadata of this object. Nested schema for pricing:
- rc
Compatible Boolean - Whether the object is compatible with the resource controller service.
- service Property Map
- The global catalog metadata of the service. Nested schema for service:
- ui Property Map
- The UI metadata of this service. Nested schema for ui:
OnboardingCatalogPlanMetadataOther, OnboardingCatalogPlanMetadataOtherArgs
- Resource
Controller OnboardingCatalog Plan Metadata Other Resource Controller - The resource controller metadata. Nested schema for resource_controller:
- Resource
Controller OnboardingCatalog Plan Metadata Other Resource Controller - The resource controller metadata. Nested schema for resource_controller:
- resource
Controller OnboardingCatalog Plan Metadata Other Resource Controller - The resource controller metadata. Nested schema for resource_controller:
- resource
Controller OnboardingCatalog Plan Metadata Other Resource Controller - The resource controller metadata. Nested schema for resource_controller:
- resource_
controller OnboardingCatalog Plan Metadata Other Resource Controller - The resource controller metadata. Nested schema for resource_controller:
- resource
Controller Property Map - The resource controller metadata. Nested schema for resource_controller:
OnboardingCatalogPlanMetadataOtherResourceController, OnboardingCatalogPlanMetadataOtherResourceControllerArgs
- Subscription
Provider stringId - The broker ID for the plan. Only needed if the service is MCSP.
- Constraints: The maximum length is
256characters. The minimum length is32characters. The value must match regular expression/^[a-zA-Z:\\-_\\d\/]+$/.
- Constraints: The maximum length is
- Subscription
Provider stringId - The broker ID for the plan. Only needed if the service is MCSP.
- Constraints: The maximum length is
256characters. The minimum length is32characters. The value must match regular expression/^[a-zA-Z:\\-_\\d\/]+$/.
- Constraints: The maximum length is
- subscription
Provider StringId - The broker ID for the plan. Only needed if the service is MCSP.
- Constraints: The maximum length is
256characters. The minimum length is32characters. The value must match regular expression/^[a-zA-Z:\\-_\\d\/]+$/.
- Constraints: The maximum length is
- subscription
Provider stringId - The broker ID for the plan. Only needed if the service is MCSP.
- Constraints: The maximum length is
256characters. The minimum length is32characters. The value must match regular expression/^[a-zA-Z:\\-_\\d\/]+$/.
- Constraints: The maximum length is
- subscription_
provider_ strid - The broker ID for the plan. Only needed if the service is MCSP.
- Constraints: The maximum length is
256characters. The minimum length is32characters. The value must match regular expression/^[a-zA-Z:\\-_\\d\/]+$/.
- Constraints: The maximum length is
- subscription
Provider StringId - The broker ID for the plan. Only needed if the service is MCSP.
- Constraints: The maximum length is
256characters. The minimum length is32characters. The value must match regular expression/^[a-zA-Z:\\-_\\d\/]+$/.
- Constraints: The maximum length is
OnboardingCatalogPlanMetadataPlan, OnboardingCatalogPlanMetadataPlanArgs
- Allow
Internal boolUsers - Controls if IBMers are allowed to provision this plan.
- Bindable bool
- Deprecated. Controls the Connections tab on the Resource Details page.
- Provision
Type string - SaaS services that integrate with MCSP for provisioning and metering should select
mcsp. If the subscription is captured as a resource subscription, but SSM/MCSP is not involved, selectibm_cloud. Otherwise, selectlegacyif the subscription is only captured as a billable subscription, and there's no resource subscription involved.- Constraints: Allowable values are:
ibm_cloud,mcsp,legacy.
- Constraints: Allowable values are:
- Reservable bool
- This field is not available for free and lite plans.
- Allow
Internal boolUsers - Controls if IBMers are allowed to provision this plan.
- Bindable bool
- Deprecated. Controls the Connections tab on the Resource Details page.
- Provision
Type string - SaaS services that integrate with MCSP for provisioning and metering should select
mcsp. If the subscription is captured as a resource subscription, but SSM/MCSP is not involved, selectibm_cloud. Otherwise, selectlegacyif the subscription is only captured as a billable subscription, and there's no resource subscription involved.- Constraints: Allowable values are:
ibm_cloud,mcsp,legacy.
- Constraints: Allowable values are:
- Reservable bool
- This field is not available for free and lite plans.
- allow
Internal BooleanUsers - Controls if IBMers are allowed to provision this plan.
- bindable Boolean
- Deprecated. Controls the Connections tab on the Resource Details page.
- provision
Type String - SaaS services that integrate with MCSP for provisioning and metering should select
mcsp. If the subscription is captured as a resource subscription, but SSM/MCSP is not involved, selectibm_cloud. Otherwise, selectlegacyif the subscription is only captured as a billable subscription, and there's no resource subscription involved.- Constraints: Allowable values are:
ibm_cloud,mcsp,legacy.
- Constraints: Allowable values are:
- reservable Boolean
- This field is not available for free and lite plans.
- allow
Internal booleanUsers - Controls if IBMers are allowed to provision this plan.
- bindable boolean
- Deprecated. Controls the Connections tab on the Resource Details page.
- provision
Type string - SaaS services that integrate with MCSP for provisioning and metering should select
mcsp. If the subscription is captured as a resource subscription, but SSM/MCSP is not involved, selectibm_cloud. Otherwise, selectlegacyif the subscription is only captured as a billable subscription, and there's no resource subscription involved.- Constraints: Allowable values are:
ibm_cloud,mcsp,legacy.
- Constraints: Allowable values are:
- reservable boolean
- This field is not available for free and lite plans.
- allow_
internal_ boolusers - Controls if IBMers are allowed to provision this plan.
- bindable bool
- Deprecated. Controls the Connections tab on the Resource Details page.
- provision_
type str - SaaS services that integrate with MCSP for provisioning and metering should select
mcsp. If the subscription is captured as a resource subscription, but SSM/MCSP is not involved, selectibm_cloud. Otherwise, selectlegacyif the subscription is only captured as a billable subscription, and there's no resource subscription involved.- Constraints: Allowable values are:
ibm_cloud,mcsp,legacy.
- Constraints: Allowable values are:
- reservable bool
- This field is not available for free and lite plans.
- allow
Internal BooleanUsers - Controls if IBMers are allowed to provision this plan.
- bindable Boolean
- Deprecated. Controls the Connections tab on the Resource Details page.
- provision
Type String - SaaS services that integrate with MCSP for provisioning and metering should select
mcsp. If the subscription is captured as a resource subscription, but SSM/MCSP is not involved, selectibm_cloud. Otherwise, selectlegacyif the subscription is only captured as a billable subscription, and there's no resource subscription involved.- Constraints: Allowable values are:
ibm_cloud,mcsp,legacy.
- Constraints: Allowable values are:
- reservable Boolean
- This field is not available for free and lite plans.
OnboardingCatalogPlanMetadataPricing, OnboardingCatalogPlanMetadataPricingArgs
- Origin string
- The source of the pricing information: global_catalog or pricing_catalog.
- Constraints: Allowable values are:
global_catalog,pricing_catalog.
- Constraints: Allowable values are:
- Sales
Avenues List<string> - Currently only available for MCSP subscription plans. Shows how the customer can purchase the plan.
- Constraints: Allowable list items are:
seller,catalog,private_offer. The maximum length is6items. The minimum length is0items.
- Constraints: Allowable list items are:
- Type string
- The type of the pricing plan.
- Constraints: Allowable values are:
free,paid,subscription.
- Constraints: Allowable values are:
- Origin string
- The source of the pricing information: global_catalog or pricing_catalog.
- Constraints: Allowable values are:
global_catalog,pricing_catalog.
- Constraints: Allowable values are:
- Sales
Avenues []string - Currently only available for MCSP subscription plans. Shows how the customer can purchase the plan.
- Constraints: Allowable list items are:
seller,catalog,private_offer. The maximum length is6items. The minimum length is0items.
- Constraints: Allowable list items are:
- Type string
- The type of the pricing plan.
- Constraints: Allowable values are:
free,paid,subscription.
- Constraints: Allowable values are:
- origin String
- The source of the pricing information: global_catalog or pricing_catalog.
- Constraints: Allowable values are:
global_catalog,pricing_catalog.
- Constraints: Allowable values are:
- sales
Avenues List<String> - Currently only available for MCSP subscription plans. Shows how the customer can purchase the plan.
- Constraints: Allowable list items are:
seller,catalog,private_offer. The maximum length is6items. The minimum length is0items.
- Constraints: Allowable list items are:
- type String
- The type of the pricing plan.
- Constraints: Allowable values are:
free,paid,subscription.
- Constraints: Allowable values are:
- origin string
- The source of the pricing information: global_catalog or pricing_catalog.
- Constraints: Allowable values are:
global_catalog,pricing_catalog.
- Constraints: Allowable values are:
- sales
Avenues string[] - Currently only available for MCSP subscription plans. Shows how the customer can purchase the plan.
- Constraints: Allowable list items are:
seller,catalog,private_offer. The maximum length is6items. The minimum length is0items.
- Constraints: Allowable list items are:
- type string
- The type of the pricing plan.
- Constraints: Allowable values are:
free,paid,subscription.
- Constraints: Allowable values are:
- origin str
- The source of the pricing information: global_catalog or pricing_catalog.
- Constraints: Allowable values are:
global_catalog,pricing_catalog.
- Constraints: Allowable values are:
- sales_
avenues Sequence[str] - Currently only available for MCSP subscription plans. Shows how the customer can purchase the plan.
- Constraints: Allowable list items are:
seller,catalog,private_offer. The maximum length is6items. The minimum length is0items.
- Constraints: Allowable list items are:
- type str
- The type of the pricing plan.
- Constraints: Allowable values are:
free,paid,subscription.
- Constraints: Allowable values are:
- origin String
- The source of the pricing information: global_catalog or pricing_catalog.
- Constraints: Allowable values are:
global_catalog,pricing_catalog.
- Constraints: Allowable values are:
- sales
Avenues List<String> - Currently only available for MCSP subscription plans. Shows how the customer can purchase the plan.
- Constraints: Allowable list items are:
seller,catalog,private_offer. The maximum length is6items. The minimum length is0items.
- Constraints: Allowable list items are:
- type String
- The type of the pricing plan.
- Constraints: Allowable values are:
free,paid,subscription.
- Constraints: Allowable values are:
OnboardingCatalogPlanMetadataService, OnboardingCatalogPlanMetadataServiceArgs
- Bindable bool
- Deprecated. Controls the Connections tab on the Resource Details page.
- Iam
Compatible bool - Whether the service is compatible with the IAM service.
- Plan
Updateable bool - Indicates plan update support and controls the Plan tab on the Resource Details page.
- Rc
Provisionable bool - Whether the service is provisionable by the resource controller service.
- Service
Key boolSupported - Indicates service credentials support and controls the Service Credential tab on Resource Details page.
- Unique
Api boolKey - Indicates whether the deployment uses a unique API key or not.
- Bindable bool
- Deprecated. Controls the Connections tab on the Resource Details page.
- Iam
Compatible bool - Whether the service is compatible with the IAM service.
- Plan
Updateable bool - Indicates plan update support and controls the Plan tab on the Resource Details page.
- Rc
Provisionable bool - Whether the service is provisionable by the resource controller service.
- Service
Key boolSupported - Indicates service credentials support and controls the Service Credential tab on Resource Details page.
- Unique
Api boolKey - Indicates whether the deployment uses a unique API key or not.
- bindable Boolean
- Deprecated. Controls the Connections tab on the Resource Details page.
- iam
Compatible Boolean - Whether the service is compatible with the IAM service.
- plan
Updateable Boolean - Indicates plan update support and controls the Plan tab on the Resource Details page.
- rc
Provisionable Boolean - Whether the service is provisionable by the resource controller service.
- service
Key BooleanSupported - Indicates service credentials support and controls the Service Credential tab on Resource Details page.
- unique
Api BooleanKey - Indicates whether the deployment uses a unique API key or not.
- bindable boolean
- Deprecated. Controls the Connections tab on the Resource Details page.
- iam
Compatible boolean - Whether the service is compatible with the IAM service.
- plan
Updateable boolean - Indicates plan update support and controls the Plan tab on the Resource Details page.
- rc
Provisionable boolean - Whether the service is provisionable by the resource controller service.
- service
Key booleanSupported - Indicates service credentials support and controls the Service Credential tab on Resource Details page.
- unique
Api booleanKey - Indicates whether the deployment uses a unique API key or not.
- bindable bool
- Deprecated. Controls the Connections tab on the Resource Details page.
- iam_
compatible bool - Whether the service is compatible with the IAM service.
- plan_
updateable bool - Indicates plan update support and controls the Plan tab on the Resource Details page.
- rc_
provisionable bool - Whether the service is provisionable by the resource controller service.
- service_
key_ boolsupported - Indicates service credentials support and controls the Service Credential tab on Resource Details page.
- unique_
api_ boolkey - Indicates whether the deployment uses a unique API key or not.
- bindable Boolean
- Deprecated. Controls the Connections tab on the Resource Details page.
- iam
Compatible Boolean - Whether the service is compatible with the IAM service.
- plan
Updateable Boolean - Indicates plan update support and controls the Plan tab on the Resource Details page.
- rc
Provisionable Boolean - Whether the service is provisionable by the resource controller service.
- service
Key BooleanSupported - Indicates service credentials support and controls the Service Credential tab on Resource Details page.
- unique
Api BooleanKey - Indicates whether the deployment uses a unique API key or not.
OnboardingCatalogPlanMetadataUi, OnboardingCatalogPlanMetadataUiArgs
- bool
- Whether the object is hidden from the consumption catalog.
- Side
By doubleSide Index - When the objects are listed side-by-side, this value controls the ordering.
- Strings
Onboarding
Catalog Plan Metadata Ui Strings - The data strings. Nested schema for strings:
- Urls
Onboarding
Catalog Plan Metadata Ui Urls - Metadata with URLs related to a service. Nested schema for urls:
- bool
- Whether the object is hidden from the consumption catalog.
- Side
By float64Side Index - When the objects are listed side-by-side, this value controls the ordering.
- Strings
Onboarding
Catalog Plan Metadata Ui Strings - The data strings. Nested schema for strings:
- Urls
Onboarding
Catalog Plan Metadata Ui Urls - Metadata with URLs related to a service. Nested schema for urls:
- Boolean
- Whether the object is hidden from the consumption catalog.
- side
By DoubleSide Index - When the objects are listed side-by-side, this value controls the ordering.
- strings
Onboarding
Catalog Plan Metadata Ui Strings - The data strings. Nested schema for strings:
- urls
Onboarding
Catalog Plan Metadata Ui Urls - Metadata with URLs related to a service. Nested schema for urls:
- boolean
- Whether the object is hidden from the consumption catalog.
- side
By numberSide Index - When the objects are listed side-by-side, this value controls the ordering.
- strings
Onboarding
Catalog Plan Metadata Ui Strings - The data strings. Nested schema for strings:
- urls
Onboarding
Catalog Plan Metadata Ui Urls - Metadata with URLs related to a service. Nested schema for urls:
- bool
- Whether the object is hidden from the consumption catalog.
- side_
by_ floatside_ index - When the objects are listed side-by-side, this value controls the ordering.
- strings
Onboarding
Catalog Plan Metadata Ui Strings - The data strings. Nested schema for strings:
- urls
Onboarding
Catalog Plan Metadata Ui Urls - Metadata with URLs related to a service. Nested schema for urls:
- Boolean
- Whether the object is hidden from the consumption catalog.
- side
By NumberSide Index - When the objects are listed side-by-side, this value controls the ordering.
- strings Property Map
- The data strings. Nested schema for strings:
- urls Property Map
- Metadata with URLs related to a service. Nested schema for urls:
OnboardingCatalogPlanMetadataUiStrings, OnboardingCatalogPlanMetadataUiStringsArgs
- En
Onboarding
Catalog Plan Metadata Ui Strings En - Translated content of additional information about the service. Nested schema for en:
- En
Onboarding
Catalog Plan Metadata Ui Strings En - Translated content of additional information about the service. Nested schema for en:
- en
Onboarding
Catalog Plan Metadata Ui Strings En - Translated content of additional information about the service. Nested schema for en:
- en
Onboarding
Catalog Plan Metadata Ui Strings En - Translated content of additional information about the service. Nested schema for en:
- en
Onboarding
Catalog Plan Metadata Ui Strings En - Translated content of additional information about the service. Nested schema for en:
- en Property Map
- Translated content of additional information about the service. Nested schema for en:
OnboardingCatalogPlanMetadataUiStringsEn, OnboardingCatalogPlanMetadataUiStringsEnArgs
- Bullets
List<Onboarding
Catalog Plan Metadata Ui Strings En Bullet> - The list of features that highlights your product's attributes and benefits for users.
- Constraints: The maximum length is
100items. The minimum length is0items. Nested schema for bullets:
- Constraints: The maximum length is
- Media
List<Onboarding
Catalog Plan Metadata Ui Strings En Media> - The list of supporting media for this product.
- Constraints: The maximum length is
100items. The minimum length is0items. Nested schema for media:
- Constraints: The maximum length is
-
List<Onboarding
Catalog Plan Metadata Ui Strings En Navigation Item> - List of custom navigation panel.
- Constraints: The maximum length is
100items. The minimum length is0items. Nested schema for navigation_items:
- Constraints: The maximum length is
- Bullets
[]Onboarding
Catalog Plan Metadata Ui Strings En Bullet - The list of features that highlights your product's attributes and benefits for users.
- Constraints: The maximum length is
100items. The minimum length is0items. Nested schema for bullets:
- Constraints: The maximum length is
- Media
[]Onboarding
Catalog Plan Metadata Ui Strings En Media - The list of supporting media for this product.
- Constraints: The maximum length is
100items. The minimum length is0items. Nested schema for media:
- Constraints: The maximum length is
-
[]Onboarding
Catalog Plan Metadata Ui Strings En Navigation Item - List of custom navigation panel.
- Constraints: The maximum length is
100items. The minimum length is0items. Nested schema for navigation_items:
- Constraints: The maximum length is
- bullets
List<Onboarding
Catalog Plan Metadata Ui Strings En Bullet> - The list of features that highlights your product's attributes and benefits for users.
- Constraints: The maximum length is
100items. The minimum length is0items. Nested schema for bullets:
- Constraints: The maximum length is
- media
List<Onboarding
Catalog Plan Metadata Ui Strings En Media> - The list of supporting media for this product.
- Constraints: The maximum length is
100items. The minimum length is0items. Nested schema for media:
- Constraints: The maximum length is
-
List<Onboarding
Catalog Plan Metadata Ui Strings En Navigation Item> - List of custom navigation panel.
- Constraints: The maximum length is
100items. The minimum length is0items. Nested schema for navigation_items:
- Constraints: The maximum length is
- bullets
Onboarding
Catalog Plan Metadata Ui Strings En Bullet[] - The list of features that highlights your product's attributes and benefits for users.
- Constraints: The maximum length is
100items. The minimum length is0items. Nested schema for bullets:
- Constraints: The maximum length is
- media
Onboarding
Catalog Plan Metadata Ui Strings En Media[] - The list of supporting media for this product.
- Constraints: The maximum length is
100items. The minimum length is0items. Nested schema for media:
- Constraints: The maximum length is
-
Onboarding
Catalog Plan Metadata Ui Strings En Navigation Item[] - List of custom navigation panel.
- Constraints: The maximum length is
100items. The minimum length is0items. Nested schema for navigation_items:
- Constraints: The maximum length is
- bullets
Sequence[Onboarding
Catalog Plan Metadata Ui Strings En Bullet] - The list of features that highlights your product's attributes and benefits for users.
- Constraints: The maximum length is
100items. The minimum length is0items. Nested schema for bullets:
- Constraints: The maximum length is
- media
Sequence[Onboarding
Catalog Plan Metadata Ui Strings En Media] - The list of supporting media for this product.
- Constraints: The maximum length is
100items. The minimum length is0items. Nested schema for media:
- Constraints: The maximum length is
-
Sequence[Onboarding
Catalog Plan Metadata Ui Strings En Navigation Item] - List of custom navigation panel.
- Constraints: The maximum length is
100items. The minimum length is0items. Nested schema for navigation_items:
- Constraints: The maximum length is
- bullets List<Property Map>
- The list of features that highlights your product's attributes and benefits for users.
- Constraints: The maximum length is
100items. The minimum length is0items. Nested schema for bullets:
- Constraints: The maximum length is
- media List<Property Map>
- The list of supporting media for this product.
- Constraints: The maximum length is
100items. The minimum length is0items. Nested schema for media:
- Constraints: The maximum length is
- List<Property Map>
- List of custom navigation panel.
- Constraints: The maximum length is
100items. The minimum length is0items. Nested schema for navigation_items:
- Constraints: The maximum length is
OnboardingCatalogPlanMetadataUiStringsEnBullet, OnboardingCatalogPlanMetadataUiStringsEnBulletArgs
- Description string
- The description about the features of the product.
- Constraints: The maximum length is
2000characters. The minimum length is0characters. The value must match regular expression/^[ -~\\s]*$/.
- Constraints: The maximum length is
- Title string
- The descriptive title for the feature.
- Constraints: The maximum length is
256characters. The minimum length is0characters. The value must match regular expression/^[ -~\\s]*$/.
- Constraints: The maximum length is
- Description string
- The description about the features of the product.
- Constraints: The maximum length is
2000characters. The minimum length is0characters. The value must match regular expression/^[ -~\\s]*$/.
- Constraints: The maximum length is
- Title string
- The descriptive title for the feature.
- Constraints: The maximum length is
256characters. The minimum length is0characters. The value must match regular expression/^[ -~\\s]*$/.
- Constraints: The maximum length is
- description String
- The description about the features of the product.
- Constraints: The maximum length is
2000characters. The minimum length is0characters. The value must match regular expression/^[ -~\\s]*$/.
- Constraints: The maximum length is
- title String
- The descriptive title for the feature.
- Constraints: The maximum length is
256characters. The minimum length is0characters. The value must match regular expression/^[ -~\\s]*$/.
- Constraints: The maximum length is
- description string
- The description about the features of the product.
- Constraints: The maximum length is
2000characters. The minimum length is0characters. The value must match regular expression/^[ -~\\s]*$/.
- Constraints: The maximum length is
- title string
- The descriptive title for the feature.
- Constraints: The maximum length is
256characters. The minimum length is0characters. The value must match regular expression/^[ -~\\s]*$/.
- Constraints: The maximum length is
- description str
- The description about the features of the product.
- Constraints: The maximum length is
2000characters. The minimum length is0characters. The value must match regular expression/^[ -~\\s]*$/.
- Constraints: The maximum length is
- title str
- The descriptive title for the feature.
- Constraints: The maximum length is
256characters. The minimum length is0characters. The value must match regular expression/^[ -~\\s]*$/.
- Constraints: The maximum length is
- description String
- The description about the features of the product.
- Constraints: The maximum length is
2000characters. The minimum length is0characters. The value must match regular expression/^[ -~\\s]*$/.
- Constraints: The maximum length is
- title String
- The descriptive title for the feature.
- Constraints: The maximum length is
256characters. The minimum length is0characters. The value must match regular expression/^[ -~\\s]*$/.
- Constraints: The maximum length is
OnboardingCatalogPlanMetadataUiStringsEnMedia, OnboardingCatalogPlanMetadataUiStringsEnMediaArgs
- Caption string
- Provide a descriptive caption that indicates what the media illustrates. This caption is displayed in the catalog.
- Constraints: The maximum length is
2000characters. The minimum length is0characters. The value must match regular expression/^[ -~\\s]*$/.
- Constraints: The maximum length is
- Type string
- The type of the media.
- Constraints: Allowable values are:
image,youtube,video_mp_4,video_webm.
- Constraints: Allowable values are:
- Url string
- The URL that links to the media that shows off the product.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- Thumbnail string
- The reduced-size version of your images and videos.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- Caption string
- Provide a descriptive caption that indicates what the media illustrates. This caption is displayed in the catalog.
- Constraints: The maximum length is
2000characters. The minimum length is0characters. The value must match regular expression/^[ -~\\s]*$/.
- Constraints: The maximum length is
- Type string
- The type of the media.
- Constraints: Allowable values are:
image,youtube,video_mp_4,video_webm.
- Constraints: Allowable values are:
- Url string
- The URL that links to the media that shows off the product.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- Thumbnail string
- The reduced-size version of your images and videos.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- caption String
- Provide a descriptive caption that indicates what the media illustrates. This caption is displayed in the catalog.
- Constraints: The maximum length is
2000characters. The minimum length is0characters. The value must match regular expression/^[ -~\\s]*$/.
- Constraints: The maximum length is
- type String
- The type of the media.
- Constraints: Allowable values are:
image,youtube,video_mp_4,video_webm.
- Constraints: Allowable values are:
- url String
- The URL that links to the media that shows off the product.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- thumbnail String
- The reduced-size version of your images and videos.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- caption string
- Provide a descriptive caption that indicates what the media illustrates. This caption is displayed in the catalog.
- Constraints: The maximum length is
2000characters. The minimum length is0characters. The value must match regular expression/^[ -~\\s]*$/.
- Constraints: The maximum length is
- type string
- The type of the media.
- Constraints: Allowable values are:
image,youtube,video_mp_4,video_webm.
- Constraints: Allowable values are:
- url string
- The URL that links to the media that shows off the product.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- thumbnail string
- The reduced-size version of your images and videos.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- caption str
- Provide a descriptive caption that indicates what the media illustrates. This caption is displayed in the catalog.
- Constraints: The maximum length is
2000characters. The minimum length is0characters. The value must match regular expression/^[ -~\\s]*$/.
- Constraints: The maximum length is
- type str
- The type of the media.
- Constraints: Allowable values are:
image,youtube,video_mp_4,video_webm.
- Constraints: Allowable values are:
- url str
- The URL that links to the media that shows off the product.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- thumbnail str
- The reduced-size version of your images and videos.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- caption String
- Provide a descriptive caption that indicates what the media illustrates. This caption is displayed in the catalog.
- Constraints: The maximum length is
2000characters. The minimum length is0characters. The value must match regular expression/^[ -~\\s]*$/.
- Constraints: The maximum length is
- type String
- The type of the media.
- Constraints: Allowable values are:
image,youtube,video_mp_4,video_webm.
- Constraints: Allowable values are:
- url String
- The URL that links to the media that shows off the product.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- thumbnail String
- The reduced-size version of your images and videos.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
OnboardingCatalogPlanMetadataUiStringsEnNavigationItem, OnboardingCatalogPlanMetadataUiStringsEnNavigationItemArgs
- Id string
- Id of custom navigation panel.
- Constraints: The maximum length is
256characters. The minimum length is0characters. The value must match regular expression/./.
- Constraints: The maximum length is
- Label string
- Url for custom navigation panel.
- Constraints: The maximum length is
256characters. The minimum length is0characters. The value must match regular expression/./.
- Constraints: The maximum length is
- Url string
- Url for custom navigation panel.
- Constraints: The maximum length is
256characters. The minimum length is0characters. The value must match regular expression/./.
- Constraints: The maximum length is
- Id string
- Id of custom navigation panel.
- Constraints: The maximum length is
256characters. The minimum length is0characters. The value must match regular expression/./.
- Constraints: The maximum length is
- Label string
- Url for custom navigation panel.
- Constraints: The maximum length is
256characters. The minimum length is0characters. The value must match regular expression/./.
- Constraints: The maximum length is
- Url string
- Url for custom navigation panel.
- Constraints: The maximum length is
256characters. The minimum length is0characters. The value must match regular expression/./.
- Constraints: The maximum length is
- id String
- Id of custom navigation panel.
- Constraints: The maximum length is
256characters. The minimum length is0characters. The value must match regular expression/./.
- Constraints: The maximum length is
- label String
- Url for custom navigation panel.
- Constraints: The maximum length is
256characters. The minimum length is0characters. The value must match regular expression/./.
- Constraints: The maximum length is
- url String
- Url for custom navigation panel.
- Constraints: The maximum length is
256characters. The minimum length is0characters. The value must match regular expression/./.
- Constraints: The maximum length is
- id string
- Id of custom navigation panel.
- Constraints: The maximum length is
256characters. The minimum length is0characters. The value must match regular expression/./.
- Constraints: The maximum length is
- label string
- Url for custom navigation panel.
- Constraints: The maximum length is
256characters. The minimum length is0characters. The value must match regular expression/./.
- Constraints: The maximum length is
- url string
- Url for custom navigation panel.
- Constraints: The maximum length is
256characters. The minimum length is0characters. The value must match regular expression/./.
- Constraints: The maximum length is
- id str
- Id of custom navigation panel.
- Constraints: The maximum length is
256characters. The minimum length is0characters. The value must match regular expression/./.
- Constraints: The maximum length is
- label str
- Url for custom navigation panel.
- Constraints: The maximum length is
256characters. The minimum length is0characters. The value must match regular expression/./.
- Constraints: The maximum length is
- url str
- Url for custom navigation panel.
- Constraints: The maximum length is
256characters. The minimum length is0characters. The value must match regular expression/./.
- Constraints: The maximum length is
- id String
- Id of custom navigation panel.
- Constraints: The maximum length is
256characters. The minimum length is0characters. The value must match regular expression/./.
- Constraints: The maximum length is
- label String
- Url for custom navigation panel.
- Constraints: The maximum length is
256characters. The minimum length is0characters. The value must match regular expression/./.
- Constraints: The maximum length is
- url String
- Url for custom navigation panel.
- Constraints: The maximum length is
256characters. The minimum length is0characters. The value must match regular expression/./.
- Constraints: The maximum length is
OnboardingCatalogPlanMetadataUiUrls, OnboardingCatalogPlanMetadataUiUrlsArgs
- Apidocs
Url string - The URL for your product's API documentation.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- Catalog
Details stringUrl - Controls the Provisioning page URL, if set the assumption is that this URL is the provisioning URL for your service.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- Custom
Create stringPage Url - Controls the Provisioning page URL, if set the assumption is that this URL is the provisioning URL for your service.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- Dashboard string
- Controls if your service has a custom dashboard or Resource Detail page.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- Doc
Url string - The URL for your product's documentation.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- Instructions
Url string - Controls the Getting Started tab on the Resource Details page. Setting it the content is loaded from the specified URL.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- Terms
Url string - The URL for your product's end user license agreement.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- Apidocs
Url string - The URL for your product's API documentation.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- Catalog
Details stringUrl - Controls the Provisioning page URL, if set the assumption is that this URL is the provisioning URL for your service.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- Custom
Create stringPage Url - Controls the Provisioning page URL, if set the assumption is that this URL is the provisioning URL for your service.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- Dashboard string
- Controls if your service has a custom dashboard or Resource Detail page.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- Doc
Url string - The URL for your product's documentation.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- Instructions
Url string - Controls the Getting Started tab on the Resource Details page. Setting it the content is loaded from the specified URL.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- Terms
Url string - The URL for your product's end user license agreement.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- apidocs
Url String - The URL for your product's API documentation.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- catalog
Details StringUrl - Controls the Provisioning page URL, if set the assumption is that this URL is the provisioning URL for your service.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- custom
Create StringPage Url - Controls the Provisioning page URL, if set the assumption is that this URL is the provisioning URL for your service.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- dashboard String
- Controls if your service has a custom dashboard or Resource Detail page.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- doc
Url String - The URL for your product's documentation.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- instructions
Url String - Controls the Getting Started tab on the Resource Details page. Setting it the content is loaded from the specified URL.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- terms
Url String - The URL for your product's end user license agreement.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- apidocs
Url string - The URL for your product's API documentation.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- catalog
Details stringUrl - Controls the Provisioning page URL, if set the assumption is that this URL is the provisioning URL for your service.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- custom
Create stringPage Url - Controls the Provisioning page URL, if set the assumption is that this URL is the provisioning URL for your service.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- dashboard string
- Controls if your service has a custom dashboard or Resource Detail page.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- doc
Url string - The URL for your product's documentation.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- instructions
Url string - Controls the Getting Started tab on the Resource Details page. Setting it the content is loaded from the specified URL.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- terms
Url string - The URL for your product's end user license agreement.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- apidocs_
url str - The URL for your product's API documentation.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- catalog_
details_ strurl - Controls the Provisioning page URL, if set the assumption is that this URL is the provisioning URL for your service.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- custom_
create_ strpage_ url - Controls the Provisioning page URL, if set the assumption is that this URL is the provisioning URL for your service.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- dashboard str
- Controls if your service has a custom dashboard or Resource Detail page.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- doc_
url str - The URL for your product's documentation.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- instructions_
url str - Controls the Getting Started tab on the Resource Details page. Setting it the content is loaded from the specified URL.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- terms_
url str - The URL for your product's end user license agreement.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- apidocs
Url String - The URL for your product's API documentation.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- catalog
Details StringUrl - Controls the Provisioning page URL, if set the assumption is that this URL is the provisioning URL for your service.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- custom
Create StringPage Url - Controls the Provisioning page URL, if set the assumption is that this URL is the provisioning URL for your service.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- dashboard String
- Controls if your service has a custom dashboard or Resource Detail page.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- doc
Url String - The URL for your product's documentation.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- instructions
Url String - Controls the Getting Started tab on the Resource Details page. Setting it the content is loaded from the specified URL.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
- terms
Url String - The URL for your product's end user license agreement.
- Constraints: The maximum length is
2083characters. The minimum length is0characters.
- Constraints: The maximum length is
OnboardingCatalogPlanObjectProvider, OnboardingCatalogPlanObjectProviderArgs
OnboardingCatalogPlanOverviewUi, OnboardingCatalogPlanOverviewUiArgs
- En
Onboarding
Catalog Plan Overview Ui En - Translated details about the service, for example, display name, short description, and long description. Nested schema for en:
- En
Onboarding
Catalog Plan Overview Ui En - Translated details about the service, for example, display name, short description, and long description. Nested schema for en:
- en
Onboarding
Catalog Plan Overview Ui En - Translated details about the service, for example, display name, short description, and long description. Nested schema for en:
- en
Onboarding
Catalog Plan Overview Ui En - Translated details about the service, for example, display name, short description, and long description. Nested schema for en:
- en
Onboarding
Catalog Plan Overview Ui En - Translated details about the service, for example, display name, short description, and long description. Nested schema for en:
- en Property Map
- Translated details about the service, for example, display name, short description, and long description. Nested schema for en:
OnboardingCatalogPlanOverviewUiEn, OnboardingCatalogPlanOverviewUiEnArgs
- Description string
- The short description of the product that is displayed in your catalog entry.
- Display
Name string - The display name of the product.
- Long
Description string - The detailed description of your product that is displayed at the beginning of your product page in the catalog. Markdown markup language is supported.
- Description string
- The short description of the product that is displayed in your catalog entry.
- Display
Name string - The display name of the product.
- Long
Description string - The detailed description of your product that is displayed at the beginning of your product page in the catalog. Markdown markup language is supported.
- description String
- The short description of the product that is displayed in your catalog entry.
- display
Name String - The display name of the product.
- long
Description String - The detailed description of your product that is displayed at the beginning of your product page in the catalog. Markdown markup language is supported.
- description string
- The short description of the product that is displayed in your catalog entry.
- display
Name string - The display name of the product.
- long
Description string - The detailed description of your product that is displayed at the beginning of your product page in the catalog. Markdown markup language is supported.
- description str
- The short description of the product that is displayed in your catalog entry.
- display_
name str - The display name of the product.
- long_
description str - The detailed description of your product that is displayed at the beginning of your product page in the catalog. Markdown markup language is supported.
- description String
- The short description of the product that is displayed in your catalog entry.
- display
Name String - The display name of the product.
- long
Description String - The detailed description of your product that is displayed at the beginning of your product page in the catalog. Markdown markup language is supported.
Import
You can import the ibm_onboarding_catalog_plan resource by using id.
The id property can be formed from product_id, catalog_product_id, and catalog_plan_id in the following format:
product_id/catalog_product_id/catalog_plan_id
product_id: A string. The unique ID of the product.catalog_product_id: A string. The unique ID of this global catalog product.catalog_plan_id: A string. The ID of a global catalog object.
Syntax
```sh $ pulumi import ibm:index/onboardingCatalogPlan:OnboardingCatalogPlan onboarding_catalog_plan product_id/catalog_product_id/catalog_plan_id; ```
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibmTerraform Provider.