1. Packages
  2. Wavefront
  3. API Docs
  4. IngestionPolicy
Wavefront v3.1.4 published on Friday, Sep 20, 2024 by Pulumi

wavefront.IngestionPolicy

Explore with Pulumi AI

wavefront logo
Wavefront v3.1.4 published on Friday, Sep 20, 2024 by Pulumi

    Provides a Wavefront Ingestion Policy Resource. This allows ingestion policies to be created, updated, and deleted.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as wavefront from "@pulumi/wavefront";
    
    const basic = new wavefront.IngestionPolicy("basic", {
        name: "test_ingestion",
        description: "An ingestion policy for testing",
    });
    
    import pulumi
    import pulumi_wavefront as wavefront
    
    basic = wavefront.IngestionPolicy("basic",
        name="test_ingestion",
        description="An ingestion policy for testing")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-wavefront/sdk/v3/go/wavefront"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := wavefront.NewIngestionPolicy(ctx, "basic", &wavefront.IngestionPolicyArgs{
    			Name:        pulumi.String("test_ingestion"),
    			Description: pulumi.String("An ingestion policy for testing"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Wavefront = Pulumi.Wavefront;
    
    return await Deployment.RunAsync(() => 
    {
        var basic = new Wavefront.IngestionPolicy("basic", new()
        {
            Name = "test_ingestion",
            Description = "An ingestion policy for testing",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.wavefront.IngestionPolicy;
    import com.pulumi.wavefront.IngestionPolicyArgs;
    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 basic = new IngestionPolicy("basic", IngestionPolicyArgs.builder()
                .name("test_ingestion")
                .description("An ingestion policy for testing")
                .build());
    
        }
    }
    
    resources:
      basic:
        type: wavefront:IngestionPolicy
        properties:
          name: test_ingestion
          description: An ingestion policy for testing
    

    Create IngestionPolicy Resource

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

    Constructor syntax

    new IngestionPolicy(name: string, args: IngestionPolicyArgs, opts?: CustomResourceOptions);
    @overload
    def IngestionPolicy(resource_name: str,
                        args: IngestionPolicyArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def IngestionPolicy(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        description: Optional[str] = None,
                        scope: Optional[str] = None,
                        accounts: Optional[Sequence[str]] = None,
                        groups: Optional[Sequence[str]] = None,
                        name: Optional[str] = None,
                        namespaces: Optional[Sequence[str]] = None,
                        sources: Optional[Sequence[str]] = None,
                        tags: Optional[Sequence[IngestionPolicyTagArgs]] = None)
    func NewIngestionPolicy(ctx *Context, name string, args IngestionPolicyArgs, opts ...ResourceOption) (*IngestionPolicy, error)
    public IngestionPolicy(string name, IngestionPolicyArgs args, CustomResourceOptions? opts = null)
    public IngestionPolicy(String name, IngestionPolicyArgs args)
    public IngestionPolicy(String name, IngestionPolicyArgs args, CustomResourceOptions options)
    
    type: wavefront:IngestionPolicy
    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 IngestionPolicyArgs
    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 IngestionPolicyArgs
    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 IngestionPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IngestionPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IngestionPolicyArgs
    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 ingestionPolicyResource = new Wavefront.IngestionPolicy("ingestionPolicyResource", new()
    {
        Description = "string",
        Scope = "string",
        Accounts = new[]
        {
            "string",
        },
        Groups = new[]
        {
            "string",
        },
        Name = "string",
        Namespaces = new[]
        {
            "string",
        },
        Sources = new[]
        {
            "string",
        },
        Tags = new[]
        {
            new Wavefront.Inputs.IngestionPolicyTagArgs
            {
                Key = "string",
                Value = "string",
            },
        },
    });
    
    example, err := wavefront.NewIngestionPolicy(ctx, "ingestionPolicyResource", &wavefront.IngestionPolicyArgs{
    	Description: pulumi.String("string"),
    	Scope:       pulumi.String("string"),
    	Accounts: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Groups: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    	Namespaces: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Sources: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Tags: wavefront.IngestionPolicyTagArray{
    		&wavefront.IngestionPolicyTagArgs{
    			Key:   pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    })
    
    var ingestionPolicyResource = new IngestionPolicy("ingestionPolicyResource", IngestionPolicyArgs.builder()
        .description("string")
        .scope("string")
        .accounts("string")
        .groups("string")
        .name("string")
        .namespaces("string")
        .sources("string")
        .tags(IngestionPolicyTagArgs.builder()
            .key("string")
            .value("string")
            .build())
        .build());
    
    ingestion_policy_resource = wavefront.IngestionPolicy("ingestionPolicyResource",
        description="string",
        scope="string",
        accounts=["string"],
        groups=["string"],
        name="string",
        namespaces=["string"],
        sources=["string"],
        tags=[wavefront.IngestionPolicyTagArgs(
            key="string",
            value="string",
        )])
    
    const ingestionPolicyResource = new wavefront.IngestionPolicy("ingestionPolicyResource", {
        description: "string",
        scope: "string",
        accounts: ["string"],
        groups: ["string"],
        name: "string",
        namespaces: ["string"],
        sources: ["string"],
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    type: wavefront:IngestionPolicy
    properties:
        accounts:
            - string
        description: string
        groups:
            - string
        name: string
        namespaces:
            - string
        scope: string
        sources:
            - string
        tags:
            - key: string
              value: string
    

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

    Description string
    The description of the ingestion policy.
    Scope string
    Accounts List<string>
    Groups List<string>
    Name string
    The name of the ingestion policy.
    Namespaces List<string>
    Sources List<string>
    Tags List<IngestionPolicyTag>
    Description string
    The description of the ingestion policy.
    Scope string
    Accounts []string
    Groups []string
    Name string
    The name of the ingestion policy.
    Namespaces []string
    Sources []string
    Tags []IngestionPolicyTagArgs
    description String
    The description of the ingestion policy.
    scope String
    accounts List<String>
    groups List<String>
    name String
    The name of the ingestion policy.
    namespaces List<String>
    sources List<String>
    tags List<IngestionPolicyTag>
    description string
    The description of the ingestion policy.
    scope string
    accounts string[]
    groups string[]
    name string
    The name of the ingestion policy.
    namespaces string[]
    sources string[]
    tags IngestionPolicyTag[]
    description str
    The description of the ingestion policy.
    scope str
    accounts Sequence[str]
    groups Sequence[str]
    name str
    The name of the ingestion policy.
    namespaces Sequence[str]
    sources Sequence[str]
    tags Sequence[IngestionPolicyTagArgs]
    description String
    The description of the ingestion policy.
    scope String
    accounts List<String>
    groups List<String>
    name String
    The name of the ingestion policy.
    namespaces List<String>
    sources List<String>
    tags List<Property Map>

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing IngestionPolicy Resource

    Get an existing IngestionPolicy 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?: IngestionPolicyState, opts?: CustomResourceOptions): IngestionPolicy
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            accounts: Optional[Sequence[str]] = None,
            description: Optional[str] = None,
            groups: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            namespaces: Optional[Sequence[str]] = None,
            scope: Optional[str] = None,
            sources: Optional[Sequence[str]] = None,
            tags: Optional[Sequence[IngestionPolicyTagArgs]] = None) -> IngestionPolicy
    func GetIngestionPolicy(ctx *Context, name string, id IDInput, state *IngestionPolicyState, opts ...ResourceOption) (*IngestionPolicy, error)
    public static IngestionPolicy Get(string name, Input<string> id, IngestionPolicyState? state, CustomResourceOptions? opts = null)
    public static IngestionPolicy get(String name, Output<String> id, IngestionPolicyState 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:
    Accounts List<string>
    Description string
    The description of the ingestion policy.
    Groups List<string>
    Name string
    The name of the ingestion policy.
    Namespaces List<string>
    Scope string
    Sources List<string>
    Tags List<IngestionPolicyTag>
    Accounts []string
    Description string
    The description of the ingestion policy.
    Groups []string
    Name string
    The name of the ingestion policy.
    Namespaces []string
    Scope string
    Sources []string
    Tags []IngestionPolicyTagArgs
    accounts List<String>
    description String
    The description of the ingestion policy.
    groups List<String>
    name String
    The name of the ingestion policy.
    namespaces List<String>
    scope String
    sources List<String>
    tags List<IngestionPolicyTag>
    accounts string[]
    description string
    The description of the ingestion policy.
    groups string[]
    name string
    The name of the ingestion policy.
    namespaces string[]
    scope string
    sources string[]
    tags IngestionPolicyTag[]
    accounts Sequence[str]
    description str
    The description of the ingestion policy.
    groups Sequence[str]
    name str
    The name of the ingestion policy.
    namespaces Sequence[str]
    scope str
    sources Sequence[str]
    tags Sequence[IngestionPolicyTagArgs]
    accounts List<String>
    description String
    The description of the ingestion policy.
    groups List<String>
    name String
    The name of the ingestion policy.
    namespaces List<String>
    scope String
    sources List<String>
    tags List<Property Map>

    Supporting Types

    IngestionPolicyTag, IngestionPolicyTagArgs

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    Import

    ingestion policies can be imported by using the id, e.g.:

    $ pulumi import wavefront:index/ingestionPolicy:IngestionPolicy basic test_ingestion-1611946841064
    

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

    Package Details

    Repository
    Wavefront pulumi/pulumi-wavefront
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the wavefront Terraform Provider.
    wavefront logo
    Wavefront v3.1.4 published on Friday, Sep 20, 2024 by Pulumi