1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Apm
  5. ApmDomain
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

oci.Apm.ApmDomain

Explore with Pulumi AI

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

    This resource provides the Apm Domain resource in Oracle Cloud Infrastructure Apm service.

    Creates a new APM domain.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testApmDomain = new oci.apm.ApmDomain("test_apm_domain", {
        compartmentId: compartmentId,
        displayName: apmDomainDisplayName,
        definedTags: {
            "foo-namespace.bar-key": "value",
        },
        description: apmDomainDescription,
        freeformTags: {
            "bar-key": "value",
        },
        isFreeTier: apmDomainIsFreeTier,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_apm_domain = oci.apm.ApmDomain("test_apm_domain",
        compartment_id=compartment_id,
        display_name=apm_domain_display_name,
        defined_tags={
            "foo-namespace.bar-key": "value",
        },
        description=apm_domain_description,
        freeform_tags={
            "bar-key": "value",
        },
        is_free_tier=apm_domain_is_free_tier)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Apm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Apm.NewApmDomain(ctx, "test_apm_domain", &Apm.ApmDomainArgs{
    			CompartmentId: pulumi.Any(compartmentId),
    			DisplayName:   pulumi.Any(apmDomainDisplayName),
    			DefinedTags: pulumi.Map{
    				"foo-namespace.bar-key": pulumi.Any("value"),
    			},
    			Description: pulumi.Any(apmDomainDescription),
    			FreeformTags: pulumi.Map{
    				"bar-key": pulumi.Any("value"),
    			},
    			IsFreeTier: pulumi.Any(apmDomainIsFreeTier),
    		})
    		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 testApmDomain = new Oci.Apm.ApmDomain("test_apm_domain", new()
        {
            CompartmentId = compartmentId,
            DisplayName = apmDomainDisplayName,
            DefinedTags = 
            {
                { "foo-namespace.bar-key", "value" },
            },
            Description = apmDomainDescription,
            FreeformTags = 
            {
                { "bar-key", "value" },
            },
            IsFreeTier = apmDomainIsFreeTier,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Apm.ApmDomain;
    import com.pulumi.oci.Apm.ApmDomainArgs;
    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 testApmDomain = new ApmDomain("testApmDomain", ApmDomainArgs.builder()
                .compartmentId(compartmentId)
                .displayName(apmDomainDisplayName)
                .definedTags(Map.of("foo-namespace.bar-key", "value"))
                .description(apmDomainDescription)
                .freeformTags(Map.of("bar-key", "value"))
                .isFreeTier(apmDomainIsFreeTier)
                .build());
    
        }
    }
    
    resources:
      testApmDomain:
        type: oci:Apm:ApmDomain
        name: test_apm_domain
        properties:
          compartmentId: ${compartmentId}
          displayName: ${apmDomainDisplayName}
          definedTags:
            foo-namespace.bar-key: value
          description: ${apmDomainDescription}
          freeformTags:
            bar-key: value
          isFreeTier: ${apmDomainIsFreeTier}
    

    Create ApmDomain Resource

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

    Constructor syntax

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

    Example

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

    var apmDomainResource = new Oci.Apm.ApmDomain("apmDomainResource", new()
    {
        CompartmentId = "string",
        DisplayName = "string",
        DefinedTags = 
        {
            { "string", "any" },
        },
        Description = "string",
        FreeformTags = 
        {
            { "string", "any" },
        },
        IsFreeTier = false,
    });
    
    example, err := Apm.NewApmDomain(ctx, "apmDomainResource", &Apm.ApmDomainArgs{
    	CompartmentId: pulumi.String("string"),
    	DisplayName:   pulumi.String("string"),
    	DefinedTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	Description: pulumi.String("string"),
    	FreeformTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	IsFreeTier: pulumi.Bool(false),
    })
    
    var apmDomainResource = new ApmDomain("apmDomainResource", ApmDomainArgs.builder()
        .compartmentId("string")
        .displayName("string")
        .definedTags(Map.of("string", "any"))
        .description("string")
        .freeformTags(Map.of("string", "any"))
        .isFreeTier(false)
        .build());
    
    apm_domain_resource = oci.apm.ApmDomain("apmDomainResource",
        compartment_id="string",
        display_name="string",
        defined_tags={
            "string": "any",
        },
        description="string",
        freeform_tags={
            "string": "any",
        },
        is_free_tier=False)
    
    const apmDomainResource = new oci.apm.ApmDomain("apmDomainResource", {
        compartmentId: "string",
        displayName: "string",
        definedTags: {
            string: "any",
        },
        description: "string",
        freeformTags: {
            string: "any",
        },
        isFreeTier: false,
    });
    
    type: oci:Apm:ApmDomain
    properties:
        compartmentId: string
        definedTags:
            string: any
        description: string
        displayName: string
        freeformTags:
            string: any
        isFreeTier: false
    

    ApmDomain Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ApmDomain resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment corresponding to the APM domain.
    DisplayName string
    (Updatable) Display name of the APM domain.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) Description of the APM domain.
    FreeformTags Dictionary<string, object>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IsFreeTier bool

    Indicates whether this is an "Always Free" resource. The default value is false.

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

    CompartmentId string
    (Updatable) The OCID of the compartment corresponding to the APM domain.
    DisplayName string
    (Updatable) Display name of the APM domain.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) Description of the APM domain.
    FreeformTags map[string]interface{}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IsFreeTier bool

    Indicates whether this is an "Always Free" resource. The default value is false.

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

    compartmentId String
    (Updatable) The OCID of the compartment corresponding to the APM domain.
    displayName String
    (Updatable) Display name of the APM domain.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) Description of the APM domain.
    freeformTags Map<String,Object>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isFreeTier Boolean

    Indicates whether this is an "Always Free" resource. The default value is false.

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

    compartmentId string
    (Updatable) The OCID of the compartment corresponding to the APM domain.
    displayName string
    (Updatable) Display name of the APM domain.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    (Updatable) Description of the APM domain.
    freeformTags {[key: string]: any}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isFreeTier boolean

    Indicates whether this is an "Always Free" resource. The default value is false.

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

    compartment_id str
    (Updatable) The OCID of the compartment corresponding to the APM domain.
    display_name str
    (Updatable) Display name of the APM domain.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    (Updatable) Description of the APM domain.
    freeform_tags Mapping[str, Any]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    is_free_tier bool

    Indicates whether this is an "Always Free" resource. The default value is false.

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

    compartmentId String
    (Updatable) The OCID of the compartment corresponding to the APM domain.
    displayName String
    (Updatable) Display name of the APM domain.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) Description of the APM domain.
    freeformTags Map<Any>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isFreeTier Boolean

    Indicates whether this is an "Always Free" resource. The default value is false.

    ** 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 ApmDomain resource produces the following output properties:

    DataUploadEndpoint string
    The endpoint where the APM agents upload their observations and metrics.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current lifecycle state of the APM domain.
    TimeCreated string
    The time the APM domain was created, expressed in RFC 3339 timestamp format.
    TimeUpdated string
    The time the APM domain was updated, expressed in RFC 3339 timestamp format.
    DataUploadEndpoint string
    The endpoint where the APM agents upload their observations and metrics.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current lifecycle state of the APM domain.
    TimeCreated string
    The time the APM domain was created, expressed in RFC 3339 timestamp format.
    TimeUpdated string
    The time the APM domain was updated, expressed in RFC 3339 timestamp format.
    dataUploadEndpoint String
    The endpoint where the APM agents upload their observations and metrics.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current lifecycle state of the APM domain.
    timeCreated String
    The time the APM domain was created, expressed in RFC 3339 timestamp format.
    timeUpdated String
    The time the APM domain was updated, expressed in RFC 3339 timestamp format.
    dataUploadEndpoint string
    The endpoint where the APM agents upload their observations and metrics.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The current lifecycle state of the APM domain.
    timeCreated string
    The time the APM domain was created, expressed in RFC 3339 timestamp format.
    timeUpdated string
    The time the APM domain was updated, expressed in RFC 3339 timestamp format.
    data_upload_endpoint str
    The endpoint where the APM agents upload their observations and metrics.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The current lifecycle state of the APM domain.
    time_created str
    The time the APM domain was created, expressed in RFC 3339 timestamp format.
    time_updated str
    The time the APM domain was updated, expressed in RFC 3339 timestamp format.
    dataUploadEndpoint String
    The endpoint where the APM agents upload their observations and metrics.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current lifecycle state of the APM domain.
    timeCreated String
    The time the APM domain was created, expressed in RFC 3339 timestamp format.
    timeUpdated String
    The time the APM domain was updated, expressed in RFC 3339 timestamp format.

    Look up Existing ApmDomain Resource

    Get an existing ApmDomain 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?: ApmDomainState, opts?: CustomResourceOptions): ApmDomain
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            compartment_id: Optional[str] = None,
            data_upload_endpoint: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            is_free_tier: Optional[bool] = None,
            state: Optional[str] = None,
            time_created: Optional[str] = None,
            time_updated: Optional[str] = None) -> ApmDomain
    func GetApmDomain(ctx *Context, name string, id IDInput, state *ApmDomainState, opts ...ResourceOption) (*ApmDomain, error)
    public static ApmDomain Get(string name, Input<string> id, ApmDomainState? state, CustomResourceOptions? opts = null)
    public static ApmDomain get(String name, Output<String> id, ApmDomainState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CompartmentId string
    (Updatable) The OCID of the compartment corresponding to the APM domain.
    DataUploadEndpoint string
    The endpoint where the APM agents upload their observations and metrics.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) Description of the APM domain.
    DisplayName string
    (Updatable) Display name of the APM domain.
    FreeformTags Dictionary<string, object>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IsFreeTier bool

    Indicates whether this is an "Always Free" resource. The default value is false.

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

    State string
    The current lifecycle state of the APM domain.
    TimeCreated string
    The time the APM domain was created, expressed in RFC 3339 timestamp format.
    TimeUpdated string
    The time the APM domain was updated, expressed in RFC 3339 timestamp format.
    CompartmentId string
    (Updatable) The OCID of the compartment corresponding to the APM domain.
    DataUploadEndpoint string
    The endpoint where the APM agents upload their observations and metrics.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) Description of the APM domain.
    DisplayName string
    (Updatable) Display name of the APM domain.
    FreeformTags map[string]interface{}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IsFreeTier bool

    Indicates whether this is an "Always Free" resource. The default value is false.

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

    State string
    The current lifecycle state of the APM domain.
    TimeCreated string
    The time the APM domain was created, expressed in RFC 3339 timestamp format.
    TimeUpdated string
    The time the APM domain was updated, expressed in RFC 3339 timestamp format.
    compartmentId String
    (Updatable) The OCID of the compartment corresponding to the APM domain.
    dataUploadEndpoint String
    The endpoint where the APM agents upload their observations and metrics.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) Description of the APM domain.
    displayName String
    (Updatable) Display name of the APM domain.
    freeformTags Map<String,Object>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isFreeTier Boolean

    Indicates whether this is an "Always Free" resource. The default value is false.

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

    state String
    The current lifecycle state of the APM domain.
    timeCreated String
    The time the APM domain was created, expressed in RFC 3339 timestamp format.
    timeUpdated String
    The time the APM domain was updated, expressed in RFC 3339 timestamp format.
    compartmentId string
    (Updatable) The OCID of the compartment corresponding to the APM domain.
    dataUploadEndpoint string
    The endpoint where the APM agents upload their observations and metrics.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    (Updatable) Description of the APM domain.
    displayName string
    (Updatable) Display name of the APM domain.
    freeformTags {[key: string]: any}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isFreeTier boolean

    Indicates whether this is an "Always Free" resource. The default value is false.

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

    state string
    The current lifecycle state of the APM domain.
    timeCreated string
    The time the APM domain was created, expressed in RFC 3339 timestamp format.
    timeUpdated string
    The time the APM domain was updated, expressed in RFC 3339 timestamp format.
    compartment_id str
    (Updatable) The OCID of the compartment corresponding to the APM domain.
    data_upload_endpoint str
    The endpoint where the APM agents upload their observations and metrics.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    (Updatable) Description of the APM domain.
    display_name str
    (Updatable) Display name of the APM domain.
    freeform_tags Mapping[str, Any]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    is_free_tier bool

    Indicates whether this is an "Always Free" resource. The default value is false.

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

    state str
    The current lifecycle state of the APM domain.
    time_created str
    The time the APM domain was created, expressed in RFC 3339 timestamp format.
    time_updated str
    The time the APM domain was updated, expressed in RFC 3339 timestamp format.
    compartmentId String
    (Updatable) The OCID of the compartment corresponding to the APM domain.
    dataUploadEndpoint String
    The endpoint where the APM agents upload their observations and metrics.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) Description of the APM domain.
    displayName String
    (Updatable) Display name of the APM domain.
    freeformTags Map<Any>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isFreeTier Boolean

    Indicates whether this is an "Always Free" resource. The default value is false.

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

    state String
    The current lifecycle state of the APM domain.
    timeCreated String
    The time the APM domain was created, expressed in RFC 3339 timestamp format.
    timeUpdated String
    The time the APM domain was updated, expressed in RFC 3339 timestamp format.

    Import

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

    $ pulumi import oci:Apm/apmDomain:ApmDomain test_apm_domain "id"
    

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

    Package Details

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