sumologic 3.1.0, Jun 27 25

sumologic 3.1.0 published on Friday, Jun 27, 2025 by sumologic

sumologic.Partition

Explore with Pulumi AI

sumologic 3.1.0 published on Friday, Jun 27, 2025 by sumologic

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  examplePartition:
    type: sumologic:Partition
    properties:
      analyticsTier: continuous
      isCompliant: false
      isIncludedInDefaultSearch: true
      lifecycle:
        preventDestroy: true
      routingExpression: _sourcecategory=*/Terraform

Attributes reference

The following attributes are exported:

id - Unique identifier for the partition.

Create Partition Resource

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

Constructor syntax

new Partition(name: string, args?: PartitionArgs, opts?: CustomResourceOptions);

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

@overload
def Partition(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              analytics_tier: Optional[str] = None,
              is_compliant: Optional[bool] = None,
              is_included_in_default_search: Optional[bool] = None,
              name: Optional[str] = None,
              partition_id: Optional[str] = None,
              reduce_retention_period_immediately: Optional[bool] = None,
              retention_period: Optional[float] = None,
              routing_expression: Optional[str] = None)

func NewPartition(ctx *Context, name string, args *PartitionArgs, opts ...ResourceOption) (*Partition, error)

public Partition(string name, PartitionArgs? args = null, CustomResourceOptions? opts = null)

public Partition(String name, PartitionArgs args)
public Partition(String name, PartitionArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args PartitionArgs: 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 partitionResource = new Sumologic.Partition("partitionResource", new()
{
    AnalyticsTier = "string",
    IsCompliant = false,
    IsIncludedInDefaultSearch = false,
    Name = "string",
    PartitionId = "string",
    ReduceRetentionPeriodImmediately = false,
    RetentionPeriod = 0,
    RoutingExpression = "string",
});

example, err := sumologic.NewPartition(ctx, "partitionResource", &sumologic.PartitionArgs{
	AnalyticsTier:                    pulumi.String("string"),
	IsCompliant:                      pulumi.Bool(false),
	IsIncludedInDefaultSearch:        pulumi.Bool(false),
	Name:                             pulumi.String("string"),
	PartitionId:                      pulumi.String("string"),
	ReduceRetentionPeriodImmediately: pulumi.Bool(false),
	RetentionPeriod:                  pulumi.Float64(0),
	RoutingExpression:                pulumi.String("string"),
})

var partitionResource = new Partition("partitionResource", PartitionArgs.builder()
    .analyticsTier("string")
    .isCompliant(false)
    .isIncludedInDefaultSearch(false)
    .name("string")
    .partitionId("string")
    .reduceRetentionPeriodImmediately(false)
    .retentionPeriod(0.0)
    .routingExpression("string")
    .build());

partition_resource = sumologic.Partition("partitionResource",
    analytics_tier="string",
    is_compliant=False,
    is_included_in_default_search=False,
    name="string",
    partition_id="string",
    reduce_retention_period_immediately=False,
    retention_period=0,
    routing_expression="string")

const partitionResource = new sumologic.Partition("partitionResource", {
    analyticsTier: "string",
    isCompliant: false,
    isIncludedInDefaultSearch: false,
    name: "string",
    partitionId: "string",
    reduceRetentionPeriodImmediately: false,
    retentionPeriod: 0,
    routingExpression: "string",
});

type: sumologic:Partition
properties:
    analyticsTier: string
    isCompliant: false
    isIncludedInDefaultSearch: false
    name: string
    partitionId: string
    reduceRetentionPeriodImmediately: false
    retentionPeriod: 0
    routingExpression: string

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

AnalyticsTier string
IsCompliant bool: Whether the partition is compliant or not. Mark a partition as compliant if it contains data used for compliance or audit purpose. Retention for a compliant partition can only be increased and cannot be reduced after the partition is marked compliant. A partition once marked compliant, cannot be marked non-compliant later.
IsIncludedInDefaultSearch bool: Indicates whether the partition is included in the default search scope. When executing a query such as "error | count," certain partitions are automatically part of the search scope. However, for specific partitions, the user must explicitly mention the partition using the _index term, as in "_index=webApp error | count". This property governs the default inclusion of the partition in the search scope. Configuring this property is exclusively permitted for flex partitions.
Name string: The name of the partition.
PartitionId string
ReduceRetentionPeriodImmediately bool: This is required on update if the newly specified retention period is less than the existing retention period. In such a situation, a value of true says that data between the existing retention period and the new retention period should be deleted immediately; if false, such data will be deleted after seven days. This property is optional and ignored if the specified retentionPeriod is greater than or equal to the current retention period.
RetentionPeriod double: The number of days to retain data in the partition, or -1 to use the default value for your account. Only relevant if your account has variable retention enabled.
RoutingExpression string: The query that defines the data to be included in the partition.

AnalyticsTier string
IsCompliant bool: Whether the partition is compliant or not. Mark a partition as compliant if it contains data used for compliance or audit purpose. Retention for a compliant partition can only be increased and cannot be reduced after the partition is marked compliant. A partition once marked compliant, cannot be marked non-compliant later.
IsIncludedInDefaultSearch bool: Indicates whether the partition is included in the default search scope. When executing a query such as "error | count," certain partitions are automatically part of the search scope. However, for specific partitions, the user must explicitly mention the partition using the _index term, as in "_index=webApp error | count". This property governs the default inclusion of the partition in the search scope. Configuring this property is exclusively permitted for flex partitions.
Name string: The name of the partition.
PartitionId string
ReduceRetentionPeriodImmediately bool: This is required on update if the newly specified retention period is less than the existing retention period. In such a situation, a value of true says that data between the existing retention period and the new retention period should be deleted immediately; if false, such data will be deleted after seven days. This property is optional and ignored if the specified retentionPeriod is greater than or equal to the current retention period.
RetentionPeriod float64: The number of days to retain data in the partition, or -1 to use the default value for your account. Only relevant if your account has variable retention enabled.
RoutingExpression string: The query that defines the data to be included in the partition.

analyticsTier String
isCompliant Boolean: Whether the partition is compliant or not. Mark a partition as compliant if it contains data used for compliance or audit purpose. Retention for a compliant partition can only be increased and cannot be reduced after the partition is marked compliant. A partition once marked compliant, cannot be marked non-compliant later.
isIncludedInDefaultSearch Boolean: Indicates whether the partition is included in the default search scope. When executing a query such as "error | count," certain partitions are automatically part of the search scope. However, for specific partitions, the user must explicitly mention the partition using the _index term, as in "_index=webApp error | count". This property governs the default inclusion of the partition in the search scope. Configuring this property is exclusively permitted for flex partitions.
name String: The name of the partition.
partitionId String
reduceRetentionPeriodImmediately Boolean: This is required on update if the newly specified retention period is less than the existing retention period. In such a situation, a value of true says that data between the existing retention period and the new retention period should be deleted immediately; if false, such data will be deleted after seven days. This property is optional and ignored if the specified retentionPeriod is greater than or equal to the current retention period.
retentionPeriod Double: The number of days to retain data in the partition, or -1 to use the default value for your account. Only relevant if your account has variable retention enabled.
routingExpression String: The query that defines the data to be included in the partition.

analyticsTier string
isCompliant boolean: Whether the partition is compliant or not. Mark a partition as compliant if it contains data used for compliance or audit purpose. Retention for a compliant partition can only be increased and cannot be reduced after the partition is marked compliant. A partition once marked compliant, cannot be marked non-compliant later.
isIncludedInDefaultSearch boolean: Indicates whether the partition is included in the default search scope. When executing a query such as "error | count," certain partitions are automatically part of the search scope. However, for specific partitions, the user must explicitly mention the partition using the _index term, as in "_index=webApp error | count". This property governs the default inclusion of the partition in the search scope. Configuring this property is exclusively permitted for flex partitions.
name string: The name of the partition.
partitionId string
reduceRetentionPeriodImmediately boolean: This is required on update if the newly specified retention period is less than the existing retention period. In such a situation, a value of true says that data between the existing retention period and the new retention period should be deleted immediately; if false, such data will be deleted after seven days. This property is optional and ignored if the specified retentionPeriod is greater than or equal to the current retention period.
retentionPeriod number: The number of days to retain data in the partition, or -1 to use the default value for your account. Only relevant if your account has variable retention enabled.
routingExpression string: The query that defines the data to be included in the partition.

analytics_tier str
is_compliant bool: Whether the partition is compliant or not. Mark a partition as compliant if it contains data used for compliance or audit purpose. Retention for a compliant partition can only be increased and cannot be reduced after the partition is marked compliant. A partition once marked compliant, cannot be marked non-compliant later.
is_included_in_default_search bool: Indicates whether the partition is included in the default search scope. When executing a query such as "error | count," certain partitions are automatically part of the search scope. However, for specific partitions, the user must explicitly mention the partition using the _index term, as in "_index=webApp error | count". This property governs the default inclusion of the partition in the search scope. Configuring this property is exclusively permitted for flex partitions.
name str: The name of the partition.
partition_id str
reduce_retention_period_immediately bool: This is required on update if the newly specified retention period is less than the existing retention period. In such a situation, a value of true says that data between the existing retention period and the new retention period should be deleted immediately; if false, such data will be deleted after seven days. This property is optional and ignored if the specified retentionPeriod is greater than or equal to the current retention period.
retention_period float: The number of days to retain data in the partition, or -1 to use the default value for your account. Only relevant if your account has variable retention enabled.
routing_expression str: The query that defines the data to be included in the partition.

analyticsTier String
isCompliant Boolean: Whether the partition is compliant or not. Mark a partition as compliant if it contains data used for compliance or audit purpose. Retention for a compliant partition can only be increased and cannot be reduced after the partition is marked compliant. A partition once marked compliant, cannot be marked non-compliant later.
isIncludedInDefaultSearch Boolean: Indicates whether the partition is included in the default search scope. When executing a query such as "error | count," certain partitions are automatically part of the search scope. However, for specific partitions, the user must explicitly mention the partition using the _index term, as in "_index=webApp error | count". This property governs the default inclusion of the partition in the search scope. Configuring this property is exclusively permitted for flex partitions.
name String: The name of the partition.
partitionId String
reduceRetentionPeriodImmediately Boolean: This is required on update if the newly specified retention period is less than the existing retention period. In such a situation, a value of true says that data between the existing retention period and the new retention period should be deleted immediately; if false, such data will be deleted after seven days. This property is optional and ignored if the specified retentionPeriod is greater than or equal to the current retention period.
retentionPeriod Number: The number of days to retain data in the partition, or -1 to use the default value for your account. Only relevant if your account has variable retention enabled.
routingExpression String: The query that defines the data to be included in the partition.

Outputs

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

DataForwardingId string
Id string: The provider-assigned unique ID for this managed resource.
IndexType string
IsActive bool
TotalBytes double

DataForwardingId string
Id string: The provider-assigned unique ID for this managed resource.
IndexType string
IsActive bool
TotalBytes float64

dataForwardingId String
id String: The provider-assigned unique ID for this managed resource.
indexType String
isActive Boolean
totalBytes Double

dataForwardingId string
id string: The provider-assigned unique ID for this managed resource.
indexType string
isActive boolean
totalBytes number

data_forwarding_id str
id str: The provider-assigned unique ID for this managed resource.
index_type str
is_active bool
total_bytes float

dataForwardingId String
id String: The provider-assigned unique ID for this managed resource.
indexType String
isActive Boolean
totalBytes Number

Look up Existing Partition Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        analytics_tier: Optional[str] = None,
        data_forwarding_id: Optional[str] = None,
        index_type: Optional[str] = None,
        is_active: Optional[bool] = None,
        is_compliant: Optional[bool] = None,
        is_included_in_default_search: Optional[bool] = None,
        name: Optional[str] = None,
        partition_id: Optional[str] = None,
        reduce_retention_period_immediately: Optional[bool] = None,
        retention_period: Optional[float] = None,
        routing_expression: Optional[str] = None,
        total_bytes: Optional[float] = None) -> Partition

func GetPartition(ctx *Context, name string, id IDInput, state *PartitionState, opts ...ResourceOption) (*Partition, error)

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

public static Partition get(String name, Output<String> id, PartitionState state, CustomResourceOptions options)

resources:  _:    type: sumologic:Partition    get:      id: ${id}

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:

AnalyticsTier string
DataForwardingId string
IndexType string
IsActive bool
IsCompliant bool: Whether the partition is compliant or not. Mark a partition as compliant if it contains data used for compliance or audit purpose. Retention for a compliant partition can only be increased and cannot be reduced after the partition is marked compliant. A partition once marked compliant, cannot be marked non-compliant later.
IsIncludedInDefaultSearch bool: Indicates whether the partition is included in the default search scope. When executing a query such as "error | count," certain partitions are automatically part of the search scope. However, for specific partitions, the user must explicitly mention the partition using the _index term, as in "_index=webApp error | count". This property governs the default inclusion of the partition in the search scope. Configuring this property is exclusively permitted for flex partitions.
Name string: The name of the partition.
PartitionId string
ReduceRetentionPeriodImmediately bool: This is required on update if the newly specified retention period is less than the existing retention period. In such a situation, a value of true says that data between the existing retention period and the new retention period should be deleted immediately; if false, such data will be deleted after seven days. This property is optional and ignored if the specified retentionPeriod is greater than or equal to the current retention period.
RetentionPeriod double: The number of days to retain data in the partition, or -1 to use the default value for your account. Only relevant if your account has variable retention enabled.
RoutingExpression string: The query that defines the data to be included in the partition.
TotalBytes double

AnalyticsTier string
DataForwardingId string
IndexType string
IsActive bool
IsCompliant bool: Whether the partition is compliant or not. Mark a partition as compliant if it contains data used for compliance or audit purpose. Retention for a compliant partition can only be increased and cannot be reduced after the partition is marked compliant. A partition once marked compliant, cannot be marked non-compliant later.
IsIncludedInDefaultSearch bool: Indicates whether the partition is included in the default search scope. When executing a query such as "error | count," certain partitions are automatically part of the search scope. However, for specific partitions, the user must explicitly mention the partition using the _index term, as in "_index=webApp error | count". This property governs the default inclusion of the partition in the search scope. Configuring this property is exclusively permitted for flex partitions.
Name string: The name of the partition.
PartitionId string
ReduceRetentionPeriodImmediately bool: This is required on update if the newly specified retention period is less than the existing retention period. In such a situation, a value of true says that data between the existing retention period and the new retention period should be deleted immediately; if false, such data will be deleted after seven days. This property is optional and ignored if the specified retentionPeriod is greater than or equal to the current retention period.
RetentionPeriod float64: The number of days to retain data in the partition, or -1 to use the default value for your account. Only relevant if your account has variable retention enabled.
RoutingExpression string: The query that defines the data to be included in the partition.
TotalBytes float64

analyticsTier String
dataForwardingId String
indexType String
isActive Boolean
isCompliant Boolean: Whether the partition is compliant or not. Mark a partition as compliant if it contains data used for compliance or audit purpose. Retention for a compliant partition can only be increased and cannot be reduced after the partition is marked compliant. A partition once marked compliant, cannot be marked non-compliant later.
isIncludedInDefaultSearch Boolean: Indicates whether the partition is included in the default search scope. When executing a query such as "error | count," certain partitions are automatically part of the search scope. However, for specific partitions, the user must explicitly mention the partition using the _index term, as in "_index=webApp error | count". This property governs the default inclusion of the partition in the search scope. Configuring this property is exclusively permitted for flex partitions.
name String: The name of the partition.
partitionId String
reduceRetentionPeriodImmediately Boolean: This is required on update if the newly specified retention period is less than the existing retention period. In such a situation, a value of true says that data between the existing retention period and the new retention period should be deleted immediately; if false, such data will be deleted after seven days. This property is optional and ignored if the specified retentionPeriod is greater than or equal to the current retention period.
retentionPeriod Double: The number of days to retain data in the partition, or -1 to use the default value for your account. Only relevant if your account has variable retention enabled.
routingExpression String: The query that defines the data to be included in the partition.
totalBytes Double

analyticsTier string
dataForwardingId string
indexType string
isActive boolean
isCompliant boolean: Whether the partition is compliant or not. Mark a partition as compliant if it contains data used for compliance or audit purpose. Retention for a compliant partition can only be increased and cannot be reduced after the partition is marked compliant. A partition once marked compliant, cannot be marked non-compliant later.
isIncludedInDefaultSearch boolean: Indicates whether the partition is included in the default search scope. When executing a query such as "error | count," certain partitions are automatically part of the search scope. However, for specific partitions, the user must explicitly mention the partition using the _index term, as in "_index=webApp error | count". This property governs the default inclusion of the partition in the search scope. Configuring this property is exclusively permitted for flex partitions.
name string: The name of the partition.
partitionId string
reduceRetentionPeriodImmediately boolean: This is required on update if the newly specified retention period is less than the existing retention period. In such a situation, a value of true says that data between the existing retention period and the new retention period should be deleted immediately; if false, such data will be deleted after seven days. This property is optional and ignored if the specified retentionPeriod is greater than or equal to the current retention period.
retentionPeriod number: The number of days to retain data in the partition, or -1 to use the default value for your account. Only relevant if your account has variable retention enabled.
routingExpression string: The query that defines the data to be included in the partition.
totalBytes number

analytics_tier str
data_forwarding_id str
index_type str
is_active bool
is_compliant bool: Whether the partition is compliant or not. Mark a partition as compliant if it contains data used for compliance or audit purpose. Retention for a compliant partition can only be increased and cannot be reduced after the partition is marked compliant. A partition once marked compliant, cannot be marked non-compliant later.
is_included_in_default_search bool: Indicates whether the partition is included in the default search scope. When executing a query such as "error | count," certain partitions are automatically part of the search scope. However, for specific partitions, the user must explicitly mention the partition using the _index term, as in "_index=webApp error | count". This property governs the default inclusion of the partition in the search scope. Configuring this property is exclusively permitted for flex partitions.
name str: The name of the partition.
partition_id str
reduce_retention_period_immediately bool: This is required on update if the newly specified retention period is less than the existing retention period. In such a situation, a value of true says that data between the existing retention period and the new retention period should be deleted immediately; if false, such data will be deleted after seven days. This property is optional and ignored if the specified retentionPeriod is greater than or equal to the current retention period.
retention_period float: The number of days to retain data in the partition, or -1 to use the default value for your account. Only relevant if your account has variable retention enabled.
routing_expression str: The query that defines the data to be included in the partition.
total_bytes float

analyticsTier String
dataForwardingId String
indexType String
isActive Boolean
isCompliant Boolean: Whether the partition is compliant or not. Mark a partition as compliant if it contains data used for compliance or audit purpose. Retention for a compliant partition can only be increased and cannot be reduced after the partition is marked compliant. A partition once marked compliant, cannot be marked non-compliant later.
isIncludedInDefaultSearch Boolean: Indicates whether the partition is included in the default search scope. When executing a query such as "error | count," certain partitions are automatically part of the search scope. However, for specific partitions, the user must explicitly mention the partition using the _index term, as in "_index=webApp error | count". This property governs the default inclusion of the partition in the search scope. Configuring this property is exclusively permitted for flex partitions.
name String: The name of the partition.
partitionId String
reduceRetentionPeriodImmediately Boolean: This is required on update if the newly specified retention period is less than the existing retention period. In such a situation, a value of true says that data between the existing retention period and the new retention period should be deleted immediately; if false, such data will be deleted after seven days. This property is optional and ignored if the specified retentionPeriod is greater than or equal to the current retention period.
retentionPeriod Number: The number of days to retain data in the partition, or -1 to use the default value for your account. Only relevant if your account has variable retention enabled.
routingExpression String: The query that defines the data to be included in the partition.
totalBytes Number

Import

Partitions can can be imported using the id. The list of partitions and their ids can be obtained using the Sumologic partions api.

hcl

$ pulumi import sumologic:index/partition:Partition partition 1234567890

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

Package Details

Repository: Sumo Logic sumologic/terraform-provider-sumologic
License
Notes: This Pulumi package is based on the sumologic Terraform Provider.

sumologic 3.1.0 published on Friday, Jun 27, 2025 by sumologic

sumologic/terraform-provider-sumologic

sumologic.Partition

On this page

On this page

Example Usage

Attributes reference

Create Partition Resource

Constructor syntax

Parameters

Constructor example

Partition Resource Properties

Inputs

Outputs

Look up Existing Partition Resource

Import

Package Details

On this page

On this page