1. Packages
  2. Signalfx Provider
  3. API Docs
  4. automatedarchival
  5. Settings
SignalFx v7.16.0 published on Tuesday, Aug 5, 2025 by Pulumi

signalfx.automatedarchival.Settings

Explore with Pulumi AI

signalfx logo
SignalFx v7.16.0 published on Tuesday, Aug 5, 2025 by Pulumi

    Create Settings Resource

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

    Constructor syntax

    new Settings(name: string, args: SettingsArgs, opts?: CustomResourceOptions);
    @overload
    def Settings(resource_name: str,
                 args: SettingsArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Settings(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 enabled: Optional[bool] = None,
                 grace_period: Optional[str] = None,
                 lookback_period: Optional[str] = None,
                 ruleset_limit: Optional[int] = None)
    func NewSettings(ctx *Context, name string, args SettingsArgs, opts ...ResourceOption) (*Settings, error)
    public Settings(string name, SettingsArgs args, CustomResourceOptions? opts = null)
    public Settings(String name, SettingsArgs args)
    public Settings(String name, SettingsArgs args, CustomResourceOptions options)
    
    type: signalfx:automatedarchival:Settings
    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 SettingsArgs
    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 SettingsArgs
    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 SettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SettingsArgs
    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 settingsResource = new SignalFx.AutomatedArchival.Settings("settingsResource", new()
    {
        Enabled = false,
        GracePeriod = "string",
        LookbackPeriod = "string",
        RulesetLimit = 0,
    });
    
    example, err := automatedarchival.NewSettings(ctx, "settingsResource", &automatedarchival.SettingsArgs{
    	Enabled:        pulumi.Bool(false),
    	GracePeriod:    pulumi.String("string"),
    	LookbackPeriod: pulumi.String("string"),
    	RulesetLimit:   pulumi.Int(0),
    })
    
    var settingsResource = new Settings("settingsResource", SettingsArgs.builder()
        .enabled(false)
        .gracePeriod("string")
        .lookbackPeriod("string")
        .rulesetLimit(0)
        .build());
    
    settings_resource = signalfx.automatedarchival.Settings("settingsResource",
        enabled=False,
        grace_period="string",
        lookback_period="string",
        ruleset_limit=0)
    
    const settingsResource = new signalfx.automatedarchival.Settings("settingsResource", {
        enabled: false,
        gracePeriod: "string",
        lookbackPeriod: "string",
        rulesetLimit: 0,
    });
    
    type: signalfx:automatedarchival:Settings
    properties:
        enabled: false
        gracePeriod: string
        lookbackPeriod: string
        rulesetLimit: 0
    

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

    Enabled bool
    Whether the automated archival is enabled for this organization or not
    GracePeriod string
    Grace period is an org level setting that applies to the newly created metrics. This allows customers to protect newly added metrics that users haven’t had the time to use in charts and detectors from being automatically archived The value here uses ISO 8061 duration format. Examples - 'P0D', 'P15D', 'P30D', 'P45D', 'P60D'
    LookbackPeriod string
    This tracks if a metric was unused in the past N number of days (N one of 30, 45, or 60). We’ll archive a metric if it wasn’t used in the lookback period. The value here uses ISO 8061 duration format. Examples - 'P30D', 'P45D', 'P60D'
    RulesetLimit int
    Org limit for the number of rulesets that can be created
    Enabled bool
    Whether the automated archival is enabled for this organization or not
    GracePeriod string
    Grace period is an org level setting that applies to the newly created metrics. This allows customers to protect newly added metrics that users haven’t had the time to use in charts and detectors from being automatically archived The value here uses ISO 8061 duration format. Examples - 'P0D', 'P15D', 'P30D', 'P45D', 'P60D'
    LookbackPeriod string
    This tracks if a metric was unused in the past N number of days (N one of 30, 45, or 60). We’ll archive a metric if it wasn’t used in the lookback period. The value here uses ISO 8061 duration format. Examples - 'P30D', 'P45D', 'P60D'
    RulesetLimit int
    Org limit for the number of rulesets that can be created
    enabled Boolean
    Whether the automated archival is enabled for this organization or not
    gracePeriod String
    Grace period is an org level setting that applies to the newly created metrics. This allows customers to protect newly added metrics that users haven’t had the time to use in charts and detectors from being automatically archived The value here uses ISO 8061 duration format. Examples - 'P0D', 'P15D', 'P30D', 'P45D', 'P60D'
    lookbackPeriod String
    This tracks if a metric was unused in the past N number of days (N one of 30, 45, or 60). We’ll archive a metric if it wasn’t used in the lookback period. The value here uses ISO 8061 duration format. Examples - 'P30D', 'P45D', 'P60D'
    rulesetLimit Integer
    Org limit for the number of rulesets that can be created
    enabled boolean
    Whether the automated archival is enabled for this organization or not
    gracePeriod string
    Grace period is an org level setting that applies to the newly created metrics. This allows customers to protect newly added metrics that users haven’t had the time to use in charts and detectors from being automatically archived The value here uses ISO 8061 duration format. Examples - 'P0D', 'P15D', 'P30D', 'P45D', 'P60D'
    lookbackPeriod string
    This tracks if a metric was unused in the past N number of days (N one of 30, 45, or 60). We’ll archive a metric if it wasn’t used in the lookback period. The value here uses ISO 8061 duration format. Examples - 'P30D', 'P45D', 'P60D'
    rulesetLimit number
    Org limit for the number of rulesets that can be created
    enabled bool
    Whether the automated archival is enabled for this organization or not
    grace_period str
    Grace period is an org level setting that applies to the newly created metrics. This allows customers to protect newly added metrics that users haven’t had the time to use in charts and detectors from being automatically archived The value here uses ISO 8061 duration format. Examples - 'P0D', 'P15D', 'P30D', 'P45D', 'P60D'
    lookback_period str
    This tracks if a metric was unused in the past N number of days (N one of 30, 45, or 60). We’ll archive a metric if it wasn’t used in the lookback period. The value here uses ISO 8061 duration format. Examples - 'P30D', 'P45D', 'P60D'
    ruleset_limit int
    Org limit for the number of rulesets that can be created
    enabled Boolean
    Whether the automated archival is enabled for this organization or not
    gracePeriod String
    Grace period is an org level setting that applies to the newly created metrics. This allows customers to protect newly added metrics that users haven’t had the time to use in charts and detectors from being automatically archived The value here uses ISO 8061 duration format. Examples - 'P0D', 'P15D', 'P30D', 'P45D', 'P60D'
    lookbackPeriod String
    This tracks if a metric was unused in the past N number of days (N one of 30, 45, or 60). We’ll archive a metric if it wasn’t used in the lookback period. The value here uses ISO 8061 duration format. Examples - 'P30D', 'P45D', 'P60D'
    rulesetLimit Number
    Org limit for the number of rulesets that can be created

    Outputs

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

    Created int
    Timestamp of when the automated archival setting was created
    Creator string
    ID of the creator of the automated archival setting
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdated int
    Timestamp of when the automated archival setting was last updated
    LastUpdatedBy string
    ID of user who last updated the automated archival setting
    Version string
    Version of the automated archival setting
    Created int
    Timestamp of when the automated archival setting was created
    Creator string
    ID of the creator of the automated archival setting
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdated int
    Timestamp of when the automated archival setting was last updated
    LastUpdatedBy string
    ID of user who last updated the automated archival setting
    Version string
    Version of the automated archival setting
    created Integer
    Timestamp of when the automated archival setting was created
    creator String
    ID of the creator of the automated archival setting
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdated Integer
    Timestamp of when the automated archival setting was last updated
    lastUpdatedBy String
    ID of user who last updated the automated archival setting
    version String
    Version of the automated archival setting
    created number
    Timestamp of when the automated archival setting was created
    creator string
    ID of the creator of the automated archival setting
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdated number
    Timestamp of when the automated archival setting was last updated
    lastUpdatedBy string
    ID of user who last updated the automated archival setting
    version string
    Version of the automated archival setting
    created int
    Timestamp of when the automated archival setting was created
    creator str
    ID of the creator of the automated archival setting
    id str
    The provider-assigned unique ID for this managed resource.
    last_updated int
    Timestamp of when the automated archival setting was last updated
    last_updated_by str
    ID of user who last updated the automated archival setting
    version str
    Version of the automated archival setting
    created Number
    Timestamp of when the automated archival setting was created
    creator String
    ID of the creator of the automated archival setting
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdated Number
    Timestamp of when the automated archival setting was last updated
    lastUpdatedBy String
    ID of user who last updated the automated archival setting
    version String
    Version of the automated archival setting

    Look up Existing Settings Resource

    Get an existing Settings 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?: SettingsState, opts?: CustomResourceOptions): Settings
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            created: Optional[int] = None,
            creator: Optional[str] = None,
            enabled: Optional[bool] = None,
            grace_period: Optional[str] = None,
            last_updated: Optional[int] = None,
            last_updated_by: Optional[str] = None,
            lookback_period: Optional[str] = None,
            ruleset_limit: Optional[int] = None,
            version: Optional[str] = None) -> Settings
    func GetSettings(ctx *Context, name string, id IDInput, state *SettingsState, opts ...ResourceOption) (*Settings, error)
    public static Settings Get(string name, Input<string> id, SettingsState? state, CustomResourceOptions? opts = null)
    public static Settings get(String name, Output<String> id, SettingsState state, CustomResourceOptions options)
    resources:  _:    type: signalfx:automatedarchival:Settings    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.
    The following state arguments are supported:
    Created int
    Timestamp of when the automated archival setting was created
    Creator string
    ID of the creator of the automated archival setting
    Enabled bool
    Whether the automated archival is enabled for this organization or not
    GracePeriod string
    Grace period is an org level setting that applies to the newly created metrics. This allows customers to protect newly added metrics that users haven’t had the time to use in charts and detectors from being automatically archived The value here uses ISO 8061 duration format. Examples - 'P0D', 'P15D', 'P30D', 'P45D', 'P60D'
    LastUpdated int
    Timestamp of when the automated archival setting was last updated
    LastUpdatedBy string
    ID of user who last updated the automated archival setting
    LookbackPeriod string
    This tracks if a metric was unused in the past N number of days (N one of 30, 45, or 60). We’ll archive a metric if it wasn’t used in the lookback period. The value here uses ISO 8061 duration format. Examples - 'P30D', 'P45D', 'P60D'
    RulesetLimit int
    Org limit for the number of rulesets that can be created
    Version string
    Version of the automated archival setting
    Created int
    Timestamp of when the automated archival setting was created
    Creator string
    ID of the creator of the automated archival setting
    Enabled bool
    Whether the automated archival is enabled for this organization or not
    GracePeriod string
    Grace period is an org level setting that applies to the newly created metrics. This allows customers to protect newly added metrics that users haven’t had the time to use in charts and detectors from being automatically archived The value here uses ISO 8061 duration format. Examples - 'P0D', 'P15D', 'P30D', 'P45D', 'P60D'
    LastUpdated int
    Timestamp of when the automated archival setting was last updated
    LastUpdatedBy string
    ID of user who last updated the automated archival setting
    LookbackPeriod string
    This tracks if a metric was unused in the past N number of days (N one of 30, 45, or 60). We’ll archive a metric if it wasn’t used in the lookback period. The value here uses ISO 8061 duration format. Examples - 'P30D', 'P45D', 'P60D'
    RulesetLimit int
    Org limit for the number of rulesets that can be created
    Version string
    Version of the automated archival setting
    created Integer
    Timestamp of when the automated archival setting was created
    creator String
    ID of the creator of the automated archival setting
    enabled Boolean
    Whether the automated archival is enabled for this organization or not
    gracePeriod String
    Grace period is an org level setting that applies to the newly created metrics. This allows customers to protect newly added metrics that users haven’t had the time to use in charts and detectors from being automatically archived The value here uses ISO 8061 duration format. Examples - 'P0D', 'P15D', 'P30D', 'P45D', 'P60D'
    lastUpdated Integer
    Timestamp of when the automated archival setting was last updated
    lastUpdatedBy String
    ID of user who last updated the automated archival setting
    lookbackPeriod String
    This tracks if a metric was unused in the past N number of days (N one of 30, 45, or 60). We’ll archive a metric if it wasn’t used in the lookback period. The value here uses ISO 8061 duration format. Examples - 'P30D', 'P45D', 'P60D'
    rulesetLimit Integer
    Org limit for the number of rulesets that can be created
    version String
    Version of the automated archival setting
    created number
    Timestamp of when the automated archival setting was created
    creator string
    ID of the creator of the automated archival setting
    enabled boolean
    Whether the automated archival is enabled for this organization or not
    gracePeriod string
    Grace period is an org level setting that applies to the newly created metrics. This allows customers to protect newly added metrics that users haven’t had the time to use in charts and detectors from being automatically archived The value here uses ISO 8061 duration format. Examples - 'P0D', 'P15D', 'P30D', 'P45D', 'P60D'
    lastUpdated number
    Timestamp of when the automated archival setting was last updated
    lastUpdatedBy string
    ID of user who last updated the automated archival setting
    lookbackPeriod string
    This tracks if a metric was unused in the past N number of days (N one of 30, 45, or 60). We’ll archive a metric if it wasn’t used in the lookback period. The value here uses ISO 8061 duration format. Examples - 'P30D', 'P45D', 'P60D'
    rulesetLimit number
    Org limit for the number of rulesets that can be created
    version string
    Version of the automated archival setting
    created int
    Timestamp of when the automated archival setting was created
    creator str
    ID of the creator of the automated archival setting
    enabled bool
    Whether the automated archival is enabled for this organization or not
    grace_period str
    Grace period is an org level setting that applies to the newly created metrics. This allows customers to protect newly added metrics that users haven’t had the time to use in charts and detectors from being automatically archived The value here uses ISO 8061 duration format. Examples - 'P0D', 'P15D', 'P30D', 'P45D', 'P60D'
    last_updated int
    Timestamp of when the automated archival setting was last updated
    last_updated_by str
    ID of user who last updated the automated archival setting
    lookback_period str
    This tracks if a metric was unused in the past N number of days (N one of 30, 45, or 60). We’ll archive a metric if it wasn’t used in the lookback period. The value here uses ISO 8061 duration format. Examples - 'P30D', 'P45D', 'P60D'
    ruleset_limit int
    Org limit for the number of rulesets that can be created
    version str
    Version of the automated archival setting
    created Number
    Timestamp of when the automated archival setting was created
    creator String
    ID of the creator of the automated archival setting
    enabled Boolean
    Whether the automated archival is enabled for this organization or not
    gracePeriod String
    Grace period is an org level setting that applies to the newly created metrics. This allows customers to protect newly added metrics that users haven’t had the time to use in charts and detectors from being automatically archived The value here uses ISO 8061 duration format. Examples - 'P0D', 'P15D', 'P30D', 'P45D', 'P60D'
    lastUpdated Number
    Timestamp of when the automated archival setting was last updated
    lastUpdatedBy String
    ID of user who last updated the automated archival setting
    lookbackPeriod String
    This tracks if a metric was unused in the past N number of days (N one of 30, 45, or 60). We’ll archive a metric if it wasn’t used in the lookback period. The value here uses ISO 8061 duration format. Examples - 'P30D', 'P45D', 'P60D'
    rulesetLimit Number
    Org limit for the number of rulesets that can be created
    version String
    Version of the automated archival setting

    Package Details

    Repository
    SignalFx pulumi/pulumi-signalfx
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the signalfx Terraform Provider.
    signalfx logo
    SignalFx v7.16.0 published on Tuesday, Aug 5, 2025 by Pulumi