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

wavefront.ServiceAccount

Explore with Pulumi AI

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

    Provides a Wavefront Service Account Resource. This allows service accounts to be created, updated, and deleted.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as wavefront from "@pulumi/wavefront";
    
    const basic = new wavefront.ServiceAccount("basic", {
        identifier: "sa::tftesting",
        active: true,
    });
    
    import pulumi
    import pulumi_wavefront as wavefront
    
    basic = wavefront.ServiceAccount("basic",
        identifier="sa::tftesting",
        active=True)
    
    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.NewServiceAccount(ctx, "basic", &wavefront.ServiceAccountArgs{
    			Identifier: pulumi.String("sa::tftesting"),
    			Active:     pulumi.Bool(true),
    		})
    		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.ServiceAccount("basic", new()
        {
            Identifier = "sa::tftesting",
            Active = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.wavefront.ServiceAccount;
    import com.pulumi.wavefront.ServiceAccountArgs;
    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 ServiceAccount("basic", ServiceAccountArgs.builder()
                .identifier("sa::tftesting")
                .active(true)
                .build());
    
        }
    }
    
    resources:
      basic:
        type: wavefront:ServiceAccount
        properties:
          identifier: sa::tftesting
          active: true
    

    Create ServiceAccount Resource

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

    Constructor syntax

    new ServiceAccount(name: string, args: ServiceAccountArgs, opts?: CustomResourceOptions);
    @overload
    def ServiceAccount(resource_name: str,
                       args: ServiceAccountArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def ServiceAccount(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       identifier: Optional[str] = None,
                       active: Optional[bool] = None,
                       description: Optional[str] = None,
                       ingestion_policy: Optional[str] = None,
                       permissions: Optional[Sequence[str]] = None,
                       user_groups: Optional[Sequence[str]] = None)
    func NewServiceAccount(ctx *Context, name string, args ServiceAccountArgs, opts ...ResourceOption) (*ServiceAccount, error)
    public ServiceAccount(string name, ServiceAccountArgs args, CustomResourceOptions? opts = null)
    public ServiceAccount(String name, ServiceAccountArgs args)
    public ServiceAccount(String name, ServiceAccountArgs args, CustomResourceOptions options)
    
    type: wavefront:ServiceAccount
    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 ServiceAccountArgs
    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 ServiceAccountArgs
    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 ServiceAccountArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceAccountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceAccountArgs
    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 serviceAccountResource = new Wavefront.ServiceAccount("serviceAccountResource", new()
    {
        Identifier = "string",
        Active = false,
        Description = "string",
        IngestionPolicy = "string",
        Permissions = new[]
        {
            "string",
        },
        UserGroups = new[]
        {
            "string",
        },
    });
    
    example, err := wavefront.NewServiceAccount(ctx, "serviceAccountResource", &wavefront.ServiceAccountArgs{
    	Identifier:      pulumi.String("string"),
    	Active:          pulumi.Bool(false),
    	Description:     pulumi.String("string"),
    	IngestionPolicy: pulumi.String("string"),
    	Permissions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	UserGroups: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var serviceAccountResource = new ServiceAccount("serviceAccountResource", ServiceAccountArgs.builder()
        .identifier("string")
        .active(false)
        .description("string")
        .ingestionPolicy("string")
        .permissions("string")
        .userGroups("string")
        .build());
    
    service_account_resource = wavefront.ServiceAccount("serviceAccountResource",
        identifier="string",
        active=False,
        description="string",
        ingestion_policy="string",
        permissions=["string"],
        user_groups=["string"])
    
    const serviceAccountResource = new wavefront.ServiceAccount("serviceAccountResource", {
        identifier: "string",
        active: false,
        description: "string",
        ingestionPolicy: "string",
        permissions: ["string"],
        userGroups: ["string"],
    });
    
    type: wavefront:ServiceAccount
    properties:
        active: false
        description: string
        identifier: string
        ingestionPolicy: string
        permissions:
            - string
        userGroups:
            - string
    

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

    Identifier string
    The unique identifier of the service account to create. Must have the prefix sa::.
    Active bool
    Whether or not the service account is active.
    Description string
    The description of the service account.
    IngestionPolicy string
    ID of ingestion policy.
    Permissions List<string>
    List of permission to grant to this service account. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
    UserGroups List<string>
    List of user groups for this service account.
    Identifier string
    The unique identifier of the service account to create. Must have the prefix sa::.
    Active bool
    Whether or not the service account is active.
    Description string
    The description of the service account.
    IngestionPolicy string
    ID of ingestion policy.
    Permissions []string
    List of permission to grant to this service account. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
    UserGroups []string
    List of user groups for this service account.
    identifier String
    The unique identifier of the service account to create. Must have the prefix sa::.
    active Boolean
    Whether or not the service account is active.
    description String
    The description of the service account.
    ingestionPolicy String
    ID of ingestion policy.
    permissions List<String>
    List of permission to grant to this service account. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
    userGroups List<String>
    List of user groups for this service account.
    identifier string
    The unique identifier of the service account to create. Must have the prefix sa::.
    active boolean
    Whether or not the service account is active.
    description string
    The description of the service account.
    ingestionPolicy string
    ID of ingestion policy.
    permissions string[]
    List of permission to grant to this service account. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
    userGroups string[]
    List of user groups for this service account.
    identifier str
    The unique identifier of the service account to create. Must have the prefix sa::.
    active bool
    Whether or not the service account is active.
    description str
    The description of the service account.
    ingestion_policy str
    ID of ingestion policy.
    permissions Sequence[str]
    List of permission to grant to this service account. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
    user_groups Sequence[str]
    List of user groups for this service account.
    identifier String
    The unique identifier of the service account to create. Must have the prefix sa::.
    active Boolean
    Whether or not the service account is active.
    description String
    The description of the service account.
    ingestionPolicy String
    ID of ingestion policy.
    permissions List<String>
    List of permission to grant to this service account. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
    userGroups List<String>
    List of user groups for this service account.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ServiceAccount 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 ServiceAccount Resource

    Get an existing ServiceAccount 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?: ServiceAccountState, opts?: CustomResourceOptions): ServiceAccount
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            active: Optional[bool] = None,
            description: Optional[str] = None,
            identifier: Optional[str] = None,
            ingestion_policy: Optional[str] = None,
            permissions: Optional[Sequence[str]] = None,
            user_groups: Optional[Sequence[str]] = None) -> ServiceAccount
    func GetServiceAccount(ctx *Context, name string, id IDInput, state *ServiceAccountState, opts ...ResourceOption) (*ServiceAccount, error)
    public static ServiceAccount Get(string name, Input<string> id, ServiceAccountState? state, CustomResourceOptions? opts = null)
    public static ServiceAccount get(String name, Output<String> id, ServiceAccountState 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:
    Active bool
    Whether or not the service account is active.
    Description string
    The description of the service account.
    Identifier string
    The unique identifier of the service account to create. Must have the prefix sa::.
    IngestionPolicy string
    ID of ingestion policy.
    Permissions List<string>
    List of permission to grant to this service account. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
    UserGroups List<string>
    List of user groups for this service account.
    Active bool
    Whether or not the service account is active.
    Description string
    The description of the service account.
    Identifier string
    The unique identifier of the service account to create. Must have the prefix sa::.
    IngestionPolicy string
    ID of ingestion policy.
    Permissions []string
    List of permission to grant to this service account. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
    UserGroups []string
    List of user groups for this service account.
    active Boolean
    Whether or not the service account is active.
    description String
    The description of the service account.
    identifier String
    The unique identifier of the service account to create. Must have the prefix sa::.
    ingestionPolicy String
    ID of ingestion policy.
    permissions List<String>
    List of permission to grant to this service account. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
    userGroups List<String>
    List of user groups for this service account.
    active boolean
    Whether or not the service account is active.
    description string
    The description of the service account.
    identifier string
    The unique identifier of the service account to create. Must have the prefix sa::.
    ingestionPolicy string
    ID of ingestion policy.
    permissions string[]
    List of permission to grant to this service account. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
    userGroups string[]
    List of user groups for this service account.
    active bool
    Whether or not the service account is active.
    description str
    The description of the service account.
    identifier str
    The unique identifier of the service account to create. Must have the prefix sa::.
    ingestion_policy str
    ID of ingestion policy.
    permissions Sequence[str]
    List of permission to grant to this service account. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
    user_groups Sequence[str]
    List of user groups for this service account.
    active Boolean
    Whether or not the service account is active.
    description String
    The description of the service account.
    identifier String
    The unique identifier of the service account to create. Must have the prefix sa::.
    ingestionPolicy String
    ID of ingestion policy.
    permissions List<String>
    List of permission to grant to this service account. Valid options are agent_management, alerts_management, dashboard_management, embedded_charts, events_management, external_links_management, host_tag_management, metrics_management, and user_management.
    userGroups List<String>
    List of user groups for this service account.

    Import

    Service accounts can be imported by using identifier, e.g.:

    $ pulumi import wavefront:index/serviceAccount:ServiceAccount basic sa::tftesting
    

    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