1. Packages
  2. Coralogix Provider
  3. API Docs
  4. ArchiveMetrics
coralogix 2.0.16 published on Monday, Apr 14, 2025 by coralogix

coralogix.ArchiveMetrics

Explore with Pulumi AI

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as coralogix from "@pulumi/coralogix";

const example = new coralogix.ArchiveMetrics("example", {s3: {
    bucket: "coralogix-c4c-eu2-prometheus-data",
    region: "eu-north-1",
}});
Copy
import pulumi
import pulumi_coralogix as coralogix

example = coralogix.ArchiveMetrics("example", s3={
    "bucket": "coralogix-c4c-eu2-prometheus-data",
    "region": "eu-north-1",
})
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/coralogix/v2/coralogix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := coralogix.NewArchiveMetrics(ctx, "example", &coralogix.ArchiveMetricsArgs{
			S3: &coralogix.ArchiveMetricsS3Args{
				Bucket: pulumi.String("coralogix-c4c-eu2-prometheus-data"),
				Region: pulumi.String("eu-north-1"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Coralogix = Pulumi.Coralogix;

return await Deployment.RunAsync(() => 
{
    var example = new Coralogix.ArchiveMetrics("example", new()
    {
        S3 = new Coralogix.Inputs.ArchiveMetricsS3Args
        {
            Bucket = "coralogix-c4c-eu2-prometheus-data",
            Region = "eu-north-1",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.coralogix.ArchiveMetrics;
import com.pulumi.coralogix.ArchiveMetricsArgs;
import com.pulumi.coralogix.inputs.ArchiveMetricsS3Args;
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 example = new ArchiveMetrics("example", ArchiveMetricsArgs.builder()
            .s3(ArchiveMetricsS3Args.builder()
                .bucket("coralogix-c4c-eu2-prometheus-data")
                .region("eu-north-1")
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: coralogix:ArchiveMetrics
    properties:
      s3:
        bucket: coralogix-c4c-eu2-prometheus-data
        region: eu-north-1
Copy

Create ArchiveMetrics Resource

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

Constructor syntax

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

@overload
def ArchiveMetrics(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   ibm: Optional[ArchiveMetricsIbmArgs] = None,
                   retention_policy: Optional[ArchiveMetricsRetentionPolicyArgs] = None,
                   s3: Optional[ArchiveMetricsS3Args] = None)
func NewArchiveMetrics(ctx *Context, name string, args *ArchiveMetricsArgs, opts ...ResourceOption) (*ArchiveMetrics, error)
public ArchiveMetrics(string name, ArchiveMetricsArgs? args = null, CustomResourceOptions? opts = null)
public ArchiveMetrics(String name, ArchiveMetricsArgs args)
public ArchiveMetrics(String name, ArchiveMetricsArgs args, CustomResourceOptions options)
type: coralogix:ArchiveMetrics
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args ArchiveMetricsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args ArchiveMetricsArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args ArchiveMetricsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args ArchiveMetricsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ArchiveMetricsArgs
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 archiveMetricsResource = new Coralogix.ArchiveMetrics("archiveMetricsResource", new()
{
    Ibm = new Coralogix.Inputs.ArchiveMetricsIbmArgs
    {
        Crn = "string",
        Endpoint = "string",
    },
    RetentionPolicy = new Coralogix.Inputs.ArchiveMetricsRetentionPolicyArgs
    {
        FiveMinutesResolution = 0,
        OneHourResolution = 0,
        RawResolution = 0,
    },
    S3 = new Coralogix.Inputs.ArchiveMetricsS3Args
    {
        Bucket = "string",
        Region = "string",
    },
});
Copy
example, err := coralogix.NewArchiveMetrics(ctx, "archiveMetricsResource", &coralogix.ArchiveMetricsArgs{
Ibm: &.ArchiveMetricsIbmArgs{
Crn: pulumi.String("string"),
Endpoint: pulumi.String("string"),
},
RetentionPolicy: &.ArchiveMetricsRetentionPolicyArgs{
FiveMinutesResolution: pulumi.Float64(0),
OneHourResolution: pulumi.Float64(0),
RawResolution: pulumi.Float64(0),
},
S3: &.ArchiveMetricsS3Args{
Bucket: pulumi.String("string"),
Region: pulumi.String("string"),
},
})
Copy
var archiveMetricsResource = new ArchiveMetrics("archiveMetricsResource", ArchiveMetricsArgs.builder()
    .ibm(ArchiveMetricsIbmArgs.builder()
        .crn("string")
        .endpoint("string")
        .build())
    .retentionPolicy(ArchiveMetricsRetentionPolicyArgs.builder()
        .fiveMinutesResolution(0)
        .oneHourResolution(0)
        .rawResolution(0)
        .build())
    .s3(ArchiveMetricsS3Args.builder()
        .bucket("string")
        .region("string")
        .build())
    .build());
Copy
archive_metrics_resource = coralogix.ArchiveMetrics("archiveMetricsResource",
    ibm={
        "crn": "string",
        "endpoint": "string",
    },
    retention_policy={
        "five_minutes_resolution": 0,
        "one_hour_resolution": 0,
        "raw_resolution": 0,
    },
    s3={
        "bucket": "string",
        "region": "string",
    })
Copy
const archiveMetricsResource = new coralogix.ArchiveMetrics("archiveMetricsResource", {
    ibm: {
        crn: "string",
        endpoint: "string",
    },
    retentionPolicy: {
        fiveMinutesResolution: 0,
        oneHourResolution: 0,
        rawResolution: 0,
    },
    s3: {
        bucket: "string",
        region: "string",
    },
});
Copy
type: coralogix:ArchiveMetrics
properties:
    ibm:
        crn: string
        endpoint: string
    retentionPolicy:
        fiveMinutesResolution: 0
        oneHourResolution: 0
        rawResolution: 0
    s3:
        bucket: string
        region: string
Copy

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

Ibm ArchiveMetricsIbm
RetentionPolicy ArchiveMetricsRetentionPolicy
The retention policy (in days) for the archived metrics. Having default values when not specified.
S3 ArchiveMetricsS3
Ibm ArchiveMetricsIbmArgs
RetentionPolicy ArchiveMetricsRetentionPolicyArgs
The retention policy (in days) for the archived metrics. Having default values when not specified.
S3 ArchiveMetricsS3Args
ibm ArchiveMetricsIbm
retentionPolicy ArchiveMetricsRetentionPolicy
The retention policy (in days) for the archived metrics. Having default values when not specified.
s3 ArchiveMetricsS3
ibm ArchiveMetricsIbm
retentionPolicy ArchiveMetricsRetentionPolicy
The retention policy (in days) for the archived metrics. Having default values when not specified.
s3 ArchiveMetricsS3
ibm ArchiveMetricsIbmArgs
retention_policy ArchiveMetricsRetentionPolicyArgs
The retention policy (in days) for the archived metrics. Having default values when not specified.
s3 ArchiveMetricsS3Args
ibm Property Map
retentionPolicy Property Map
The retention policy (in days) for the archived metrics. Having default values when not specified.
s3 Property Map

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Prefix string
TenantId double
Id string
The provider-assigned unique ID for this managed resource.
Prefix string
TenantId float64
id String
The provider-assigned unique ID for this managed resource.
prefix String
tenantId Double
id string
The provider-assigned unique ID for this managed resource.
prefix string
tenantId number
id str
The provider-assigned unique ID for this managed resource.
prefix str
tenant_id float
id String
The provider-assigned unique ID for this managed resource.
prefix String
tenantId Number

Look up Existing ArchiveMetrics Resource

Get an existing ArchiveMetrics 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?: ArchiveMetricsState, opts?: CustomResourceOptions): ArchiveMetrics
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ibm: Optional[ArchiveMetricsIbmArgs] = None,
        prefix: Optional[str] = None,
        retention_policy: Optional[ArchiveMetricsRetentionPolicyArgs] = None,
        s3: Optional[ArchiveMetricsS3Args] = None,
        tenant_id: Optional[float] = None) -> ArchiveMetrics
func GetArchiveMetrics(ctx *Context, name string, id IDInput, state *ArchiveMetricsState, opts ...ResourceOption) (*ArchiveMetrics, error)
public static ArchiveMetrics Get(string name, Input<string> id, ArchiveMetricsState? state, CustomResourceOptions? opts = null)
public static ArchiveMetrics get(String name, Output<String> id, ArchiveMetricsState state, CustomResourceOptions options)
resources:  _:    type: coralogix:ArchiveMetrics    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Ibm ArchiveMetricsIbm
Prefix string
RetentionPolicy ArchiveMetricsRetentionPolicy
The retention policy (in days) for the archived metrics. Having default values when not specified.
S3 ArchiveMetricsS3
TenantId double
Ibm ArchiveMetricsIbmArgs
Prefix string
RetentionPolicy ArchiveMetricsRetentionPolicyArgs
The retention policy (in days) for the archived metrics. Having default values when not specified.
S3 ArchiveMetricsS3Args
TenantId float64
ibm ArchiveMetricsIbm
prefix String
retentionPolicy ArchiveMetricsRetentionPolicy
The retention policy (in days) for the archived metrics. Having default values when not specified.
s3 ArchiveMetricsS3
tenantId Double
ibm ArchiveMetricsIbm
prefix string
retentionPolicy ArchiveMetricsRetentionPolicy
The retention policy (in days) for the archived metrics. Having default values when not specified.
s3 ArchiveMetricsS3
tenantId number
ibm ArchiveMetricsIbmArgs
prefix str
retention_policy ArchiveMetricsRetentionPolicyArgs
The retention policy (in days) for the archived metrics. Having default values when not specified.
s3 ArchiveMetricsS3Args
tenant_id float
ibm Property Map
prefix String
retentionPolicy Property Map
The retention policy (in days) for the archived metrics. Having default values when not specified.
s3 Property Map
tenantId Number

Supporting Types

ArchiveMetricsIbm
, ArchiveMetricsIbmArgs

Crn This property is required. string
Endpoint This property is required. string
Crn This property is required. string
Endpoint This property is required. string
crn This property is required. String
endpoint This property is required. String
crn This property is required. string
endpoint This property is required. string
crn This property is required. str
endpoint This property is required. str
crn This property is required. String
endpoint This property is required. String

ArchiveMetricsRetentionPolicy
, ArchiveMetricsRetentionPolicyArgs

FiveMinutesResolution This property is required. double
OneHourResolution This property is required. double
RawResolution This property is required. double
FiveMinutesResolution This property is required. float64
OneHourResolution This property is required. float64
RawResolution This property is required. float64
fiveMinutesResolution This property is required. Double
oneHourResolution This property is required. Double
rawResolution This property is required. Double
fiveMinutesResolution This property is required. number
oneHourResolution This property is required. number
rawResolution This property is required. number
five_minutes_resolution This property is required. float
one_hour_resolution This property is required. float
raw_resolution This property is required. float
fiveMinutesResolution This property is required. Number
oneHourResolution This property is required. Number
rawResolution This property is required. Number

ArchiveMetricsS3
, ArchiveMetricsS3Args

Bucket This property is required. string
The bucket name to store the archived metrics in.
Region This property is required. string
The bucket region. see - https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html#Concepts.RegionsAndAvailabilityZones.Regions
Bucket This property is required. string
The bucket name to store the archived metrics in.
Region This property is required. string
The bucket region. see - https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html#Concepts.RegionsAndAvailabilityZones.Regions
bucket This property is required. String
The bucket name to store the archived metrics in.
region This property is required. String
The bucket region. see - https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html#Concepts.RegionsAndAvailabilityZones.Regions
bucket This property is required. string
The bucket name to store the archived metrics in.
region This property is required. string
The bucket region. see - https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html#Concepts.RegionsAndAvailabilityZones.Regions
bucket This property is required. str
The bucket name to store the archived metrics in.
region This property is required. str
The bucket region. see - https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html#Concepts.RegionsAndAvailabilityZones.Regions
bucket This property is required. String
The bucket name to store the archived metrics in.
region This property is required. String
The bucket region. see - https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html#Concepts.RegionsAndAvailabilityZones.Regions

Package Details

Repository
coralogix coralogix/terraform-provider-coralogix
License
Notes
This Pulumi package is based on the coralogix Terraform Provider.