NS1 v3.4.6, Oct 18 24

NS1 v3.4.6 published on Friday, Oct 18, 2024 by Pulumi

ns1.Dataset

Explore with Pulumi AI

NS1 v3.4.6 published on Friday, Oct 18, 2024 by Pulumi

Create Dataset Resource

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

Constructor syntax

new Dataset(name: string, args: DatasetArgs, opts?: CustomResourceOptions);

@overload
def Dataset(resource_name: str,
            args: DatasetArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Dataset(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            datatype: Optional[DatasetDatatypeArgs] = None,
            export_type: Optional[str] = None,
            timeframe: Optional[DatasetTimeframeArgs] = None,
            name: Optional[str] = None,
            recipient_emails: Optional[Sequence[str]] = None,
            repeat: Optional[DatasetRepeatArgs] = None)

func NewDataset(ctx *Context, name string, args DatasetArgs, opts ...ResourceOption) (*Dataset, error)

public Dataset(string name, DatasetArgs args, CustomResourceOptions? opts = null)

public Dataset(String name, DatasetArgs args)
public Dataset(String name, DatasetArgs args, CustomResourceOptions options)

type: ns1:Dataset
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 DatasetArgs: 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 DatasetArgs: 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 DatasetArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DatasetArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DatasetArgs: 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 datasetResource = new Ns1.Dataset("datasetResource", new()
{
    Datatype = new Ns1.Inputs.DatasetDatatypeArgs
    {
        Data = 
        {
            { "string", "string" },
        },
        Scope = "string",
        Type = "string",
    },
    ExportType = "string",
    Timeframe = new Ns1.Inputs.DatasetTimeframeArgs
    {
        Aggregation = "string",
        Cycles = 0,
        From = 0,
        To = 0,
    },
    Name = "string",
    RecipientEmails = new[]
    {
        "string",
    },
    Repeat = new Ns1.Inputs.DatasetRepeatArgs
    {
        EndAfterN = 0,
        RepeatsEvery = "string",
        Start = 0,
    },
});

example, err := ns1.NewDataset(ctx, "datasetResource", &ns1.DatasetArgs{
	Datatype: &ns1.DatasetDatatypeArgs{
		Data: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		Scope: pulumi.String("string"),
		Type:  pulumi.String("string"),
	},
	ExportType: pulumi.String("string"),
	Timeframe: &ns1.DatasetTimeframeArgs{
		Aggregation: pulumi.String("string"),
		Cycles:      pulumi.Int(0),
		From:        pulumi.Int(0),
		To:          pulumi.Int(0),
	},
	Name: pulumi.String("string"),
	RecipientEmails: pulumi.StringArray{
		pulumi.String("string"),
	},
	Repeat: &ns1.DatasetRepeatArgs{
		EndAfterN:    pulumi.Int(0),
		RepeatsEvery: pulumi.String("string"),
		Start:        pulumi.Int(0),
	},
})

var datasetResource = new Dataset("datasetResource", DatasetArgs.builder()
    .datatype(DatasetDatatypeArgs.builder()
        .data(Map.of("string", "string"))
        .scope("string")
        .type("string")
        .build())
    .exportType("string")
    .timeframe(DatasetTimeframeArgs.builder()
        .aggregation("string")
        .cycles(0)
        .from(0)
        .to(0)
        .build())
    .name("string")
    .recipientEmails("string")
    .repeat(DatasetRepeatArgs.builder()
        .endAfterN(0)
        .repeatsEvery("string")
        .start(0)
        .build())
    .build());

dataset_resource = ns1.Dataset("datasetResource",
    datatype={
        "data": {
            "string": "string",
        },
        "scope": "string",
        "type": "string",
    },
    export_type="string",
    timeframe={
        "aggregation": "string",
        "cycles": 0,
        "from_": 0,
        "to": 0,
    },
    name="string",
    recipient_emails=["string"],
    repeat={
        "end_after_n": 0,
        "repeats_every": "string",
        "start": 0,
    })

const datasetResource = new ns1.Dataset("datasetResource", {
    datatype: {
        data: {
            string: "string",
        },
        scope: "string",
        type: "string",
    },
    exportType: "string",
    timeframe: {
        aggregation: "string",
        cycles: 0,
        from: 0,
        to: 0,
    },
    name: "string",
    recipientEmails: ["string"],
    repeat: {
        endAfterN: 0,
        repeatsEvery: "string",
        start: 0,
    },
});

type: ns1:Dataset
properties:
    datatype:
        data:
            string: string
        scope: string
        type: string
    exportType: string
    name: string
    recipientEmails:
        - string
    repeat:
        endAfterN: 0
        repeatsEvery: string
        start: 0
    timeframe:
        aggregation: string
        cycles: 0
        from: 0
        to: 0

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

Datatype DatasetDatatype
ExportType string
Timeframe DatasetTimeframe
Name string
RecipientEmails List<string>
Repeat DatasetRepeat

Datatype DatasetDatatypeArgs
ExportType string
Timeframe DatasetTimeframeArgs
Name string
RecipientEmails []string
Repeat DatasetRepeatArgs

datatype DatasetDatatype
exportType String
timeframe DatasetTimeframe
name String
recipientEmails List<String>
repeat DatasetRepeat

datatype DatasetDatatype
exportType string
timeframe DatasetTimeframe
name string
recipientEmails string[]
repeat DatasetRepeat

datatype DatasetDatatypeArgs
export_type str
timeframe DatasetTimeframeArgs
name str
recipient_emails Sequence[str]
repeat DatasetRepeatArgs

datatype Property Map
exportType String
timeframe Property Map
name String
recipientEmails List<String>
repeat Property Map

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Reports List<DatasetReport>

Id string: The provider-assigned unique ID for this managed resource.
Reports []DatasetReport

id String: The provider-assigned unique ID for this managed resource.
reports List<DatasetReport>

id string: The provider-assigned unique ID for this managed resource.
reports DatasetReport[]

id str: The provider-assigned unique ID for this managed resource.
reports Sequence[DatasetReport]

id String: The provider-assigned unique ID for this managed resource.
reports List<Property Map>

Look up Existing Dataset Resource

Get an existing Dataset 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?: DatasetState, opts?: CustomResourceOptions): Dataset

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        datatype: Optional[DatasetDatatypeArgs] = None,
        export_type: Optional[str] = None,
        name: Optional[str] = None,
        recipient_emails: Optional[Sequence[str]] = None,
        repeat: Optional[DatasetRepeatArgs] = None,
        reports: Optional[Sequence[DatasetReportArgs]] = None,
        timeframe: Optional[DatasetTimeframeArgs] = None) -> Dataset

func GetDataset(ctx *Context, name string, id IDInput, state *DatasetState, opts ...ResourceOption) (*Dataset, error)

public static Dataset Get(string name, Input<string> id, DatasetState? state, CustomResourceOptions? opts = null)

public static Dataset get(String name, Output<String> id, DatasetState 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:

Datatype DatasetDatatype
ExportType string
Name string
RecipientEmails List<string>
Repeat DatasetRepeat
Reports List<DatasetReport>
Timeframe DatasetTimeframe

Datatype DatasetDatatypeArgs
ExportType string
Name string
RecipientEmails []string
Repeat DatasetRepeatArgs
Reports []DatasetReportArgs
Timeframe DatasetTimeframeArgs

datatype DatasetDatatype
exportType String
name String
recipientEmails List<String>
repeat DatasetRepeat
reports List<DatasetReport>
timeframe DatasetTimeframe

datatype DatasetDatatype
exportType string
name string
recipientEmails string[]
repeat DatasetRepeat
reports DatasetReport[]
timeframe DatasetTimeframe

datatype DatasetDatatypeArgs
export_type str
name str
recipient_emails Sequence[str]
repeat DatasetRepeatArgs
reports Sequence[DatasetReportArgs]
timeframe DatasetTimeframeArgs

datatype Property Map
exportType String
name String
recipientEmails List<String>
repeat Property Map
reports List<Property Map>
timeframe Property Map

Supporting Types

DatasetDatatype, DatasetDatatypeArgs

Data Dictionary<string, string>
Scope string
Type string

Data map[string]string
Scope string
Type string

data Map<String,String>
scope String
type String

data {[key: string]: string}
scope string
type string

data Mapping[str, str]
scope str
type str

data Map<String>
scope String
type String

DatasetRepeat, DatasetRepeatArgs

EndAfterN int
RepeatsEvery string
Start int

EndAfterN int
RepeatsEvery string
Start int

endAfterN Integer
repeatsEvery String
start Integer

endAfterN number
repeatsEvery string
start number

end_after_n int
repeats_every str
start int

endAfterN Number
repeatsEvery String
start Number

DatasetReport, DatasetReportArgs

CreatedAt int
End int
Id string
Start int
Status string

CreatedAt int
End int
Id string
Start int
Status string

createdAt Integer
end Integer
id String
start Integer
status String

createdAt number
end number
id string
start number
status string

created_at int
end int
id str
start int
status str

createdAt Number
end Number
id String
start Number
status String

DatasetTimeframe, DatasetTimeframeArgs

Aggregation string
Cycles int
From int
To int

Aggregation string
Cycles int
From int
To int

aggregation String
cycles Integer
from Integer
to Integer

aggregation string
cycles number
from number
to number

aggregation str
cycles int
from_ int
to int

aggregation String
cycles Number
from Number
to Number

Package Details

Repository: NS1 pulumi/pulumi-ns1
License: Apache-2.0
Notes: This Pulumi package is based on the ns1 Terraform Provider.

NS1 v3.4.6 published on Friday, Oct 18, 2024 by Pulumi

pulumi/pulumi-ns1

ns1.Dataset

On this page

On this page

Create Dataset Resource

Constructor syntax

Parameters

Constructor example

Dataset Resource Properties

Inputs

Outputs

Look up Existing Dataset Resource

Supporting Types

DatasetDatatype, DatasetDatatypeArgs

DatasetRepeat, DatasetRepeatArgs

DatasetReport, DatasetReportArgs

DatasetTimeframe, DatasetTimeframeArgs

Package Details

On this page

On this page