1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. FleetAppsManagement
  5. Onboarding
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.FleetAppsManagement.Onboarding

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

    This resource provides the Onboarding resource in Oracle Cloud Infrastructure Fleet Apps Management service.

    Onboard a tenant to Fleet Application Management Service

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testOnboarding = new oci.fleetappsmanagement.Onboarding("test_onboarding", {
        compartmentId: compartmentId,
        isCostTrackingTagEnabled: onboardingIsCostTrackingTagEnabled,
        isFamsTagEnabled: onboardingIsFamsTagEnabled,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_onboarding = oci.fleet_apps_management.Onboarding("test_onboarding",
        compartment_id=compartment_id,
        is_cost_tracking_tag_enabled=onboarding_is_cost_tracking_tag_enabled,
        is_fams_tag_enabled=onboarding_is_fams_tag_enabled)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/FleetAppsManagement"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := FleetAppsManagement.NewOnboarding(ctx, "test_onboarding", &FleetAppsManagement.OnboardingArgs{
    			CompartmentId:            pulumi.Any(compartmentId),
    			IsCostTrackingTagEnabled: pulumi.Any(onboardingIsCostTrackingTagEnabled),
    			IsFamsTagEnabled:         pulumi.Any(onboardingIsFamsTagEnabled),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testOnboarding = new Oci.FleetAppsManagement.Onboarding("test_onboarding", new()
        {
            CompartmentId = compartmentId,
            IsCostTrackingTagEnabled = onboardingIsCostTrackingTagEnabled,
            IsFamsTagEnabled = onboardingIsFamsTagEnabled,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.FleetAppsManagement.Onboarding;
    import com.pulumi.oci.FleetAppsManagement.OnboardingArgs;
    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 testOnboarding = new Onboarding("testOnboarding", OnboardingArgs.builder()
                .compartmentId(compartmentId)
                .isCostTrackingTagEnabled(onboardingIsCostTrackingTagEnabled)
                .isFamsTagEnabled(onboardingIsFamsTagEnabled)
                .build());
    
        }
    }
    
    resources:
      testOnboarding:
        type: oci:FleetAppsManagement:Onboarding
        name: test_onboarding
        properties:
          compartmentId: ${compartmentId}
          isCostTrackingTagEnabled: ${onboardingIsCostTrackingTagEnabled}
          isFamsTagEnabled: ${onboardingIsFamsTagEnabled}
    

    Create Onboarding Resource

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

    Constructor syntax

    new Onboarding(name: string, args: OnboardingArgs, opts?: CustomResourceOptions);
    @overload
    def Onboarding(resource_name: str,
                   args: OnboardingArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def Onboarding(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   compartment_id: Optional[str] = None,
                   is_cost_tracking_tag_enabled: Optional[bool] = None,
                   is_fams_tag_enabled: Optional[bool] = None)
    func NewOnboarding(ctx *Context, name string, args OnboardingArgs, opts ...ResourceOption) (*Onboarding, error)
    public Onboarding(string name, OnboardingArgs args, CustomResourceOptions? opts = null)
    public Onboarding(String name, OnboardingArgs args)
    public Onboarding(String name, OnboardingArgs args, CustomResourceOptions options)
    
    type: oci:FleetAppsManagement:Onboarding
    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 OnboardingArgs
    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 OnboardingArgs
    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 OnboardingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OnboardingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OnboardingArgs
    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 onboardingResource = new Oci.FleetAppsManagement.Onboarding("onboardingResource", new()
    {
        CompartmentId = "string",
        IsCostTrackingTagEnabled = false,
        IsFamsTagEnabled = false,
    });
    
    example, err := FleetAppsManagement.NewOnboarding(ctx, "onboardingResource", &FleetAppsManagement.OnboardingArgs{
    	CompartmentId:            pulumi.String("string"),
    	IsCostTrackingTagEnabled: pulumi.Bool(false),
    	IsFamsTagEnabled:         pulumi.Bool(false),
    })
    
    var onboardingResource = new Onboarding("onboardingResource", OnboardingArgs.builder()
        .compartmentId("string")
        .isCostTrackingTagEnabled(false)
        .isFamsTagEnabled(false)
        .build());
    
    onboarding_resource = oci.fleet_apps_management.Onboarding("onboardingResource",
        compartment_id="string",
        is_cost_tracking_tag_enabled=False,
        is_fams_tag_enabled=False)
    
    const onboardingResource = new oci.fleetappsmanagement.Onboarding("onboardingResource", {
        compartmentId: "string",
        isCostTrackingTagEnabled: false,
        isFamsTagEnabled: false,
    });
    
    type: oci:FleetAppsManagement:Onboarding
    properties:
        compartmentId: string
        isCostTrackingTagEnabled: false
        isFamsTagEnabled: false
    

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

    CompartmentId string
    Tenancy OCID
    IsCostTrackingTagEnabled bool
    A value determining if cost tracking tag is enabled or not
    IsFamsTagEnabled bool

    A value determining FAMS tag is enabled or not

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

    CompartmentId string
    Tenancy OCID
    IsCostTrackingTagEnabled bool
    A value determining if cost tracking tag is enabled or not
    IsFamsTagEnabled bool

    A value determining FAMS tag is enabled or not

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

    compartmentId String
    Tenancy OCID
    isCostTrackingTagEnabled Boolean
    A value determining if cost tracking tag is enabled or not
    isFamsTagEnabled Boolean

    A value determining FAMS tag is enabled or not

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

    compartmentId string
    Tenancy OCID
    isCostTrackingTagEnabled boolean
    A value determining if cost tracking tag is enabled or not
    isFamsTagEnabled boolean

    A value determining FAMS tag is enabled or not

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

    compartment_id str
    Tenancy OCID
    is_cost_tracking_tag_enabled bool
    A value determining if cost tracking tag is enabled or not
    is_fams_tag_enabled bool

    A value determining FAMS tag is enabled or not

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

    compartmentId String
    Tenancy OCID
    isCostTrackingTagEnabled Boolean
    A value determining if cost tracking tag is enabled or not
    isFamsTagEnabled Boolean

    A value determining FAMS tag is enabled or not

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

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceRegion string
    Associated region
    State string
    The current state of the Onboarding.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time this resource was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time this resource was last updated. An RFC3339 formatted datetime string.
    Version string
    Version of FAMS the tenant is onboarded to.
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceRegion string
    Associated region
    State string
    The current state of the Onboarding.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time this resource was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time this resource was last updated. An RFC3339 formatted datetime string.
    Version string
    Version of FAMS the tenant is onboarded to.
    id String
    The provider-assigned unique ID for this managed resource.
    resourceRegion String
    Associated region
    state String
    The current state of the Onboarding.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time this resource was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time this resource was last updated. An RFC3339 formatted datetime string.
    version String
    Version of FAMS the tenant is onboarded to.
    id string
    The provider-assigned unique ID for this managed resource.
    resourceRegion string
    Associated region
    state string
    The current state of the Onboarding.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time this resource was created. An RFC3339 formatted datetime string.
    timeUpdated string
    The time this resource was last updated. An RFC3339 formatted datetime string.
    version string
    Version of FAMS the tenant is onboarded to.
    id str
    The provider-assigned unique ID for this managed resource.
    resource_region str
    Associated region
    state str
    The current state of the Onboarding.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time this resource was created. An RFC3339 formatted datetime string.
    time_updated str
    The time this resource was last updated. An RFC3339 formatted datetime string.
    version str
    Version of FAMS the tenant is onboarded to.
    id String
    The provider-assigned unique ID for this managed resource.
    resourceRegion String
    Associated region
    state String
    The current state of the Onboarding.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time this resource was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time this resource was last updated. An RFC3339 formatted datetime string.
    version String
    Version of FAMS the tenant is onboarded to.

    Look up Existing Onboarding Resource

    Get an existing Onboarding 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?: OnboardingState, opts?: CustomResourceOptions): Onboarding
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            compartment_id: Optional[str] = None,
            is_cost_tracking_tag_enabled: Optional[bool] = None,
            is_fams_tag_enabled: Optional[bool] = None,
            resource_region: Optional[str] = None,
            state: Optional[str] = None,
            system_tags: Optional[Mapping[str, str]] = None,
            time_created: Optional[str] = None,
            time_updated: Optional[str] = None,
            version: Optional[str] = None) -> Onboarding
    func GetOnboarding(ctx *Context, name string, id IDInput, state *OnboardingState, opts ...ResourceOption) (*Onboarding, error)
    public static Onboarding Get(string name, Input<string> id, OnboardingState? state, CustomResourceOptions? opts = null)
    public static Onboarding get(String name, Output<String> id, OnboardingState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CompartmentId string
    Tenancy OCID
    IsCostTrackingTagEnabled bool
    A value determining if cost tracking tag is enabled or not
    IsFamsTagEnabled bool

    A value determining FAMS tag is enabled or not

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

    ResourceRegion string
    Associated region
    State string
    The current state of the Onboarding.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time this resource was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time this resource was last updated. An RFC3339 formatted datetime string.
    Version string
    Version of FAMS the tenant is onboarded to.
    CompartmentId string
    Tenancy OCID
    IsCostTrackingTagEnabled bool
    A value determining if cost tracking tag is enabled or not
    IsFamsTagEnabled bool

    A value determining FAMS tag is enabled or not

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

    ResourceRegion string
    Associated region
    State string
    The current state of the Onboarding.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time this resource was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time this resource was last updated. An RFC3339 formatted datetime string.
    Version string
    Version of FAMS the tenant is onboarded to.
    compartmentId String
    Tenancy OCID
    isCostTrackingTagEnabled Boolean
    A value determining if cost tracking tag is enabled or not
    isFamsTagEnabled Boolean

    A value determining FAMS tag is enabled or not

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

    resourceRegion String
    Associated region
    state String
    The current state of the Onboarding.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time this resource was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time this resource was last updated. An RFC3339 formatted datetime string.
    version String
    Version of FAMS the tenant is onboarded to.
    compartmentId string
    Tenancy OCID
    isCostTrackingTagEnabled boolean
    A value determining if cost tracking tag is enabled or not
    isFamsTagEnabled boolean

    A value determining FAMS tag is enabled or not

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

    resourceRegion string
    Associated region
    state string
    The current state of the Onboarding.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time this resource was created. An RFC3339 formatted datetime string.
    timeUpdated string
    The time this resource was last updated. An RFC3339 formatted datetime string.
    version string
    Version of FAMS the tenant is onboarded to.
    compartment_id str
    Tenancy OCID
    is_cost_tracking_tag_enabled bool
    A value determining if cost tracking tag is enabled or not
    is_fams_tag_enabled bool

    A value determining FAMS tag is enabled or not

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

    resource_region str
    Associated region
    state str
    The current state of the Onboarding.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time this resource was created. An RFC3339 formatted datetime string.
    time_updated str
    The time this resource was last updated. An RFC3339 formatted datetime string.
    version str
    Version of FAMS the tenant is onboarded to.
    compartmentId String
    Tenancy OCID
    isCostTrackingTagEnabled Boolean
    A value determining if cost tracking tag is enabled or not
    isFamsTagEnabled Boolean

    A value determining FAMS tag is enabled or not

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

    resourceRegion String
    Associated region
    state String
    The current state of the Onboarding.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time this resource was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time this resource was last updated. An RFC3339 formatted datetime string.
    version String
    Version of FAMS the tenant is onboarded to.

    Import

    Import is not supported for this resource.

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

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi