Docs Home
Sumo Logic v0.23.7 published on Thursday, Oct 24, 2024 by Pulumi
sumologic.Field
Explore with Pulumi AI
Provides a Sumologic Field.
Create Field Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Field(name: string, args: FieldArgs, opts?: CustomResourceOptions);@overload
def Field(resource_name: str,
args: FieldArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Field(resource_name: str,
opts: Optional[ResourceOptions] = None,
field_name: Optional[str] = None,
data_type: Optional[str] = None,
state: Optional[str] = None)func NewField(ctx *Context, name string, args FieldArgs, opts ...ResourceOption) (*Field, error)public Field(string name, FieldArgs args, CustomResourceOptions? opts = null)type: sumologic:Field
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 FieldArgs
- 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 FieldArgs
- 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 FieldArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FieldArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FieldArgs
- 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 fieldResource = new SumoLogic.Field("fieldResource", new()
{
FieldName = "string",
DataType = "string",
State = "string",
});
example, err := sumologic.NewField(ctx, "fieldResource", &sumologic.FieldArgs{
FieldName: pulumi.String("string"),
DataType: pulumi.String("string"),
State: pulumi.String("string"),
})
var fieldResource = new Field("fieldResource", FieldArgs.builder()
.fieldName("string")
.dataType("string")
.state("string")
.build());
field_resource = sumologic.Field("fieldResource",
field_name="string",
data_type="string",
state="string")
const fieldResource = new sumologic.Field("fieldResource", {
fieldName: "string",
dataType: "string",
state: "string",
});
type: sumologic:Field
properties:
dataType: string
fieldName: string
state: string
Field 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 Field resource accepts the following input properties:
- field_
name str - Name of the field.
- data_
type str - state str
- State of the field (either
EnabledorDisabled).
Outputs
All input properties are implicitly available as output properties. Additionally, the Field resource produces the following output properties:
Look up Existing Field Resource
Get an existing Field 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?: FieldState, opts?: CustomResourceOptions): Field@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
data_type: Optional[str] = None,
field_id: Optional[str] = None,
field_name: Optional[str] = None,
state: Optional[str] = None) -> Fieldfunc GetField(ctx *Context, name string, id IDInput, state *FieldState, opts ...ResourceOption) (*Field, error)public static Field Get(string name, Input<string> id, FieldState? state, CustomResourceOptions? opts = null)public static Field get(String name, Output<String> id, FieldState 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.
- data_
type str - field_
id str - Field identifier.
- field_
name str - Name of the field.
- state str
- State of the field (either
EnabledorDisabled).
Import
Fields can be imported using the field id, e.g.:
hcl
$ pulumi import sumologic:index/field:Field field 000000000ABC1234
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Sumo Logic pulumi/pulumi-sumologic
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
sumologicTerraform Provider.