Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ns1 Provider
  3. API Docs
  4. Application
NS1 v3.4.6 published on Friday, Oct 18, 2024 by Pulumi
pulumi/pulumi-ns1

ns1.Application

Explore with Pulumi AI

ns1 logo
NS1 v3.4.6 published on Friday, Oct 18, 2024 by Pulumi
pulumi/pulumi-ns1

    Provides a NS1 Pulsar application resource. This can be used to create, modify, and delete applications.

    Create Application Resource

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

    Constructor syntax

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

@overload
def Application(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                active: Optional[bool] = None,
                browser_wait_millis: Optional[int] = None,
                default_config: Optional[ApplicationDefaultConfigArgs] = None,
                jobs_per_transaction: Optional[int] = None,
                name: Optional[str] = None)
    func NewApplication(ctx *Context, name string, args *ApplicationArgs, opts ...ResourceOption) (*Application, error)
    public Application(string name, ApplicationArgs? args = null, CustomResourceOptions? opts = null)
    public Application(String name, ApplicationArgs args)
public Application(String name, ApplicationArgs args, CustomResourceOptions options)

    type: ns1:Application
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 ApplicationArgs
    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 ApplicationArgs
    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 ApplicationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApplicationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApplicationArgs
    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 applicationResource = new Ns1.Application("applicationResource", new()
{
    Active = false,
    BrowserWaitMillis = 0,
    DefaultConfig = new Ns1.Inputs.ApplicationDefaultConfigArgs
    {
        Http = false,
        Https = false,
        JobTimeoutMillis = 0,
        RequestTimeoutMillis = 0,
        StaticValues = false,
        UseXhr = false,
    },
    JobsPerTransaction = 0,
    Name = "string",
});

    example, err := ns1.NewApplication(ctx, "applicationResource", &ns1.ApplicationArgs{
	Active:            pulumi.Bool(false),
	BrowserWaitMillis: pulumi.Int(0),
	DefaultConfig: &ns1.ApplicationDefaultConfigArgs{
		Http:                 pulumi.Bool(false),
		Https:                pulumi.Bool(false),
		JobTimeoutMillis:     pulumi.Int(0),
		RequestTimeoutMillis: pulumi.Int(0),
		StaticValues:         pulumi.Bool(false),
		UseXhr:               pulumi.Bool(false),
	},
	JobsPerTransaction: pulumi.Int(0),
	Name:               pulumi.String("string"),
})

    var applicationResource = new Application("applicationResource", ApplicationArgs.builder()
    .active(false)
    .browserWaitMillis(0)
    .defaultConfig(ApplicationDefaultConfigArgs.builder()
        .http(false)
        .https(false)
        .jobTimeoutMillis(0)
        .requestTimeoutMillis(0)
        .staticValues(false)
        .useXhr(false)
        .build())
    .jobsPerTransaction(0)
    .name("string")
    .build());

    application_resource = ns1.Application("applicationResource",
    active=False,
    browser_wait_millis=0,
    default_config={
        "http": False,
        "https": False,
        "job_timeout_millis": 0,
        "request_timeout_millis": 0,
        "static_values": False,
        "use_xhr": False,
    },
    jobs_per_transaction=0,
    name="string")

    const applicationResource = new ns1.Application("applicationResource", {
    active: false,
    browserWaitMillis: 0,
    defaultConfig: {
        http: false,
        https: false,
        jobTimeoutMillis: 0,
        requestTimeoutMillis: 0,
        staticValues: false,
        useXhr: false,
    },
    jobsPerTransaction: 0,
    name: "string",
});

    type: ns1:Application
properties:
    active: false
    browserWaitMillis: 0
    defaultConfig:
        http: false
        https: false
        jobTimeoutMillis: 0
        requestTimeoutMillis: 0
        staticValues: false
        useXhr: false
    jobsPerTransaction: 0
    name: string

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

    Active bool
    Indicates whether or not this application is currently active and usable for traffic steering.
    BrowserWaitMillis int
    The amount of time (in milliseconds) the browser should wait before running measurements.
    DefaultConfig ApplicationDefaultConfig
    Default job configuration. If a field is present here and not on a specific job associated with this application, the default value specified here is used..
    JobsPerTransaction int
    Number of jobs to measure per user impression.
    Name string
    Descriptive name for this Pulsar app.
    Active bool
    Indicates whether or not this application is currently active and usable for traffic steering.
    BrowserWaitMillis int
    The amount of time (in milliseconds) the browser should wait before running measurements.
    DefaultConfig ApplicationDefaultConfigArgs
    Default job configuration. If a field is present here and not on a specific job associated with this application, the default value specified here is used..
    JobsPerTransaction int
    Number of jobs to measure per user impression.
    Name string
    Descriptive name for this Pulsar app.
    active Boolean
    Indicates whether or not this application is currently active and usable for traffic steering.
    browserWaitMillis Integer
    The amount of time (in milliseconds) the browser should wait before running measurements.
    defaultConfig ApplicationDefaultConfig
    Default job configuration. If a field is present here and not on a specific job associated with this application, the default value specified here is used..
    jobsPerTransaction Integer
    Number of jobs to measure per user impression.
    name String
    Descriptive name for this Pulsar app.
    active boolean
    Indicates whether or not this application is currently active and usable for traffic steering.
    browserWaitMillis number
    The amount of time (in milliseconds) the browser should wait before running measurements.
    defaultConfig ApplicationDefaultConfig
    Default job configuration. If a field is present here and not on a specific job associated with this application, the default value specified here is used..
    jobsPerTransaction number
    Number of jobs to measure per user impression.
    name string
    Descriptive name for this Pulsar app.
    active bool
    Indicates whether or not this application is currently active and usable for traffic steering.
    browser_wait_millis int
    The amount of time (in milliseconds) the browser should wait before running measurements.
    default_config ApplicationDefaultConfigArgs
    Default job configuration. If a field is present here and not on a specific job associated with this application, the default value specified here is used..
    jobs_per_transaction int
    Number of jobs to measure per user impression.
    name str
    Descriptive name for this Pulsar app.
    active Boolean
    Indicates whether or not this application is currently active and usable for traffic steering.
    browserWaitMillis Number
    The amount of time (in milliseconds) the browser should wait before running measurements.
    defaultConfig Property Map
    Default job configuration. If a field is present here and not on a specific job associated with this application, the default value specified here is used..
    jobsPerTransaction Number
    Number of jobs to measure per user impression.
    name String
    Descriptive name for this Pulsar app.

    Outputs

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

    Get an existing Application 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?: ApplicationState, opts?: CustomResourceOptions): Application
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        browser_wait_millis: Optional[int] = None,
        default_config: Optional[ApplicationDefaultConfigArgs] = None,
        jobs_per_transaction: Optional[int] = None,
        name: Optional[str] = None) -> Application
    func GetApplication(ctx *Context, name string, id IDInput, state *ApplicationState, opts ...ResourceOption) (*Application, error)
    public static Application Get(string name, Input<string> id, ApplicationState? state, CustomResourceOptions? opts = null)
    public static Application get(String name, Output<String> id, ApplicationState 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
    Indicates whether or not this application is currently active and usable for traffic steering.
    BrowserWaitMillis int
    The amount of time (in milliseconds) the browser should wait before running measurements.
    DefaultConfig ApplicationDefaultConfig
    Default job configuration. If a field is present here and not on a specific job associated with this application, the default value specified here is used..
    JobsPerTransaction int
    Number of jobs to measure per user impression.
    Name string
    Descriptive name for this Pulsar app.
    Active bool
    Indicates whether or not this application is currently active and usable for traffic steering.
    BrowserWaitMillis int
    The amount of time (in milliseconds) the browser should wait before running measurements.
    DefaultConfig ApplicationDefaultConfigArgs
    Default job configuration. If a field is present here and not on a specific job associated with this application, the default value specified here is used..
    JobsPerTransaction int
    Number of jobs to measure per user impression.
    Name string
    Descriptive name for this Pulsar app.
    active Boolean
    Indicates whether or not this application is currently active and usable for traffic steering.
    browserWaitMillis Integer
    The amount of time (in milliseconds) the browser should wait before running measurements.
    defaultConfig ApplicationDefaultConfig
    Default job configuration. If a field is present here and not on a specific job associated with this application, the default value specified here is used..
    jobsPerTransaction Integer
    Number of jobs to measure per user impression.
    name String
    Descriptive name for this Pulsar app.
    active boolean
    Indicates whether or not this application is currently active and usable for traffic steering.
    browserWaitMillis number
    The amount of time (in milliseconds) the browser should wait before running measurements.
    defaultConfig ApplicationDefaultConfig
    Default job configuration. If a field is present here and not on a specific job associated with this application, the default value specified here is used..
    jobsPerTransaction number
    Number of jobs to measure per user impression.
    name string
    Descriptive name for this Pulsar app.
    active bool
    Indicates whether or not this application is currently active and usable for traffic steering.
    browser_wait_millis int
    The amount of time (in milliseconds) the browser should wait before running measurements.
    default_config ApplicationDefaultConfigArgs
    Default job configuration. If a field is present here and not on a specific job associated with this application, the default value specified here is used..
    jobs_per_transaction int
    Number of jobs to measure per user impression.
    name str
    Descriptive name for this Pulsar app.
    active Boolean
    Indicates whether or not this application is currently active and usable for traffic steering.
    browserWaitMillis Number
    The amount of time (in milliseconds) the browser should wait before running measurements.
    defaultConfig Property Map
    Default job configuration. If a field is present here and not on a specific job associated with this application, the default value specified here is used..
    jobsPerTransaction Number
    Number of jobs to measure per user impression.
    name String
    Descriptive name for this Pulsar app.

    Supporting Types

    ApplicationDefaultConfig, ApplicationDefaultConfigArgs

    Http bool
    Indicates whether or not to use HTTP in measurements.
    Https bool
    Indicates whether or not to use HTTPS in measurements.
    JobTimeoutMillis int
    Maximum timeout per job 0, the primary NSONE Global Network. Normally, you should not have to worry about this.
    RequestTimeoutMillis int
    Maximum timeout per request.
    StaticValues bool
    Indicates whether or not to skip aggregation for this job's measurements
    UseXhr bool
    Whether to use XMLHttpRequest (XHR) when taking measurements.
    Http bool
    Indicates whether or not to use HTTP in measurements.
    Https bool
    Indicates whether or not to use HTTPS in measurements.
    JobTimeoutMillis int
    Maximum timeout per job 0, the primary NSONE Global Network. Normally, you should not have to worry about this.
    RequestTimeoutMillis int
    Maximum timeout per request.
    StaticValues bool
    Indicates whether or not to skip aggregation for this job's measurements
    UseXhr bool
    Whether to use XMLHttpRequest (XHR) when taking measurements.
    http Boolean
    Indicates whether or not to use HTTP in measurements.
    https Boolean
    Indicates whether or not to use HTTPS in measurements.
    jobTimeoutMillis Integer
    Maximum timeout per job 0, the primary NSONE Global Network. Normally, you should not have to worry about this.
    requestTimeoutMillis Integer
    Maximum timeout per request.
    staticValues Boolean
    Indicates whether or not to skip aggregation for this job's measurements
    useXhr Boolean
    Whether to use XMLHttpRequest (XHR) when taking measurements.
    http boolean
    Indicates whether or not to use HTTP in measurements.
    https boolean
    Indicates whether or not to use HTTPS in measurements.
    jobTimeoutMillis number
    Maximum timeout per job 0, the primary NSONE Global Network. Normally, you should not have to worry about this.
    requestTimeoutMillis number
    Maximum timeout per request.
    staticValues boolean
    Indicates whether or not to skip aggregation for this job's measurements
    useXhr boolean
    Whether to use XMLHttpRequest (XHR) when taking measurements.
    http bool
    Indicates whether or not to use HTTP in measurements.
    https bool
    Indicates whether or not to use HTTPS in measurements.
    job_timeout_millis int
    Maximum timeout per job 0, the primary NSONE Global Network. Normally, you should not have to worry about this.
    request_timeout_millis int
    Maximum timeout per request.
    static_values bool
    Indicates whether or not to skip aggregation for this job's measurements
    use_xhr bool
    Whether to use XMLHttpRequest (XHR) when taking measurements.
    http Boolean
    Indicates whether or not to use HTTP in measurements.
    https Boolean
    Indicates whether or not to use HTTPS in measurements.
    jobTimeoutMillis Number
    Maximum timeout per job 0, the primary NSONE Global Network. Normally, you should not have to worry about this.
    requestTimeoutMillis Number
    Maximum timeout per request.
    staticValues Boolean
    Indicates whether or not to skip aggregation for this job's measurements
    useXhr Boolean
    Whether to use XMLHttpRequest (XHR) when taking measurements.

    Import

    $ pulumi import ns1:index/application:Application `ns1_application`

    So for the example above:

    $ pulumi import ns1:index/application:Application example terraform.example.io`

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

    Package Details

    Repository
    NS1 pulumi/pulumi-ns1
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ns1 Terraform Provider.
    ns1 logo
    NS1 v3.4.6 published on Friday, Oct 18, 2024 by Pulumi
    pulumi/pulumi-ns1