Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Prismacloud Provider
  3. API Docs
  4. SavedSearch
prismacloud 1.7.0 published on Monday, Apr 14, 2025 by paloaltonetworks
paloaltonetworks/terraform-provider-prismacloud

prismacloud.SavedSearch

Explore with Pulumi AI

prismacloud logo
prismacloud 1.7.0 published on Monday, Apr 14, 2025 by paloaltonetworks
paloaltonetworks/terraform-provider-prismacloud

    Import

    Resources can be imported using the saved-search ID:

    $ pulumi import prismacloud:index/savedSearch:SavedSearch example 11111111-2222-3333-4444-555555555555

    Create SavedSearch Resource

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

    Constructor syntax

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

@overload
def SavedSearch(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                query: Optional[str] = None,
                search_id: Optional[str] = None,
                cloud_type: Optional[str] = None,
                description: Optional[str] = None,
                name: Optional[str] = None,
                saved_search_id: Optional[str] = None,
                time_range: Optional[SavedSearchTimeRangeArgs] = None)
    func NewSavedSearch(ctx *Context, name string, args SavedSearchArgs, opts ...ResourceOption) (*SavedSearch, error)
    public SavedSearch(string name, SavedSearchArgs args, CustomResourceOptions? opts = null)
    public SavedSearch(String name, SavedSearchArgs args)
public SavedSearch(String name, SavedSearchArgs args, CustomResourceOptions options)

    type: prismacloud:SavedSearch
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 SavedSearchArgs
    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 SavedSearchArgs
    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 SavedSearchArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SavedSearchArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SavedSearchArgs
    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 savedSearchResource = new Prismacloud.SavedSearch("savedSearchResource", new()
{
    Query = "string",
    SearchId = "string",
    CloudType = "string",
    Description = "string",
    Name = "string",
    SavedSearchId = "string",
    TimeRange = new Prismacloud.Inputs.SavedSearchTimeRangeArgs
    {
        Absolute = new Prismacloud.Inputs.SavedSearchTimeRangeAbsoluteArgs
        {
            End = 0,
            Start = 0,
        },
        Relative = new Prismacloud.Inputs.SavedSearchTimeRangeRelativeArgs
        {
            Amount = 0,
            Unit = "string",
        },
        ToNow = new Prismacloud.Inputs.SavedSearchTimeRangeToNowArgs
        {
            Unit = "string",
        },
    },
});

    example, err := prismacloud.NewSavedSearch(ctx, "savedSearchResource", &prismacloud.SavedSearchArgs{
	Query:         pulumi.String("string"),
	SearchId:      pulumi.String("string"),
	CloudType:     pulumi.String("string"),
	Description:   pulumi.String("string"),
	Name:          pulumi.String("string"),
	SavedSearchId: pulumi.String("string"),
	TimeRange: &prismacloud.SavedSearchTimeRangeArgs{
		Absolute: &prismacloud.SavedSearchTimeRangeAbsoluteArgs{
			End:   pulumi.Float64(0),
			Start: pulumi.Float64(0),
		},
		Relative: &prismacloud.SavedSearchTimeRangeRelativeArgs{
			Amount: pulumi.Float64(0),
			Unit:   pulumi.String("string"),
		},
		ToNow: &prismacloud.SavedSearchTimeRangeToNowArgs{
			Unit: pulumi.String("string"),
		},
	},
})

    var savedSearchResource = new SavedSearch("savedSearchResource", SavedSearchArgs.builder()
    .query("string")
    .searchId("string")
    .cloudType("string")
    .description("string")
    .name("string")
    .savedSearchId("string")
    .timeRange(SavedSearchTimeRangeArgs.builder()
        .absolute(SavedSearchTimeRangeAbsoluteArgs.builder()
            .end(0)
            .start(0)
            .build())
        .relative(SavedSearchTimeRangeRelativeArgs.builder()
            .amount(0)
            .unit("string")
            .build())
        .toNow(SavedSearchTimeRangeToNowArgs.builder()
            .unit("string")
            .build())
        .build())
    .build());

    saved_search_resource = prismacloud.SavedSearch("savedSearchResource",
    query="string",
    search_id="string",
    cloud_type="string",
    description="string",
    name="string",
    saved_search_id="string",
    time_range={
        "absolute": {
            "end": 0,
            "start": 0,
        },
        "relative": {
            "amount": 0,
            "unit": "string",
        },
        "to_now": {
            "unit": "string",
        },
    })

    const savedSearchResource = new prismacloud.SavedSearch("savedSearchResource", {
    query: "string",
    searchId: "string",
    cloudType: "string",
    description: "string",
    name: "string",
    savedSearchId: "string",
    timeRange: {
        absolute: {
            end: 0,
            start: 0,
        },
        relative: {
            amount: 0,
            unit: "string",
        },
        toNow: {
            unit: "string",
        },
    },
});

    type: prismacloud:SavedSearch
properties:
    cloudType: string
    description: string
    name: string
    query: string
    savedSearchId: string
    searchId: string
    timeRange:
        absolute:
            end: 0
            start: 0
        relative:
            amount: 0
            unit: string
        toNow:
            unit: string

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

    Query string
    The RQL query.
    SearchId string
    The search ID.
    CloudType string
    Cloud type. Valid values: aws, azure, gcp, alibaba_cloud or oci.
    Description string
    Description.
    Name string
    Name (Must be unique and is immutable).
    SavedSearchId string
    TimeRange SavedSearchTimeRange
    The RQL time range spec, as defined below.
    Query string
    The RQL query.
    SearchId string
    The search ID.
    CloudType string
    Cloud type. Valid values: aws, azure, gcp, alibaba_cloud or oci.
    Description string
    Description.
    Name string
    Name (Must be unique and is immutable).
    SavedSearchId string
    TimeRange SavedSearchTimeRangeArgs
    The RQL time range spec, as defined below.
    query String
    The RQL query.
    searchId String
    The search ID.
    cloudType String
    Cloud type. Valid values: aws, azure, gcp, alibaba_cloud or oci.
    description String
    Description.
    name String
    Name (Must be unique and is immutable).
    savedSearchId String
    timeRange SavedSearchTimeRange
    The RQL time range spec, as defined below.
    query string
    The RQL query.
    searchId string
    The search ID.
    cloudType string
    Cloud type. Valid values: aws, azure, gcp, alibaba_cloud or oci.
    description string
    Description.
    name string
    Name (Must be unique and is immutable).
    savedSearchId string
    timeRange SavedSearchTimeRange
    The RQL time range spec, as defined below.
    query str
    The RQL query.
    search_id str
    The search ID.
    cloud_type str
    Cloud type. Valid values: aws, azure, gcp, alibaba_cloud or oci.
    description str
    Description.
    name str
    Name (Must be unique and is immutable).
    saved_search_id str
    time_range SavedSearchTimeRangeArgs
    The RQL time range spec, as defined below.
    query String
    The RQL query.
    searchId String
    The search ID.
    cloudType String
    Cloud type. Valid values: aws, azure, gcp, alibaba_cloud or oci.
    description String
    Description.
    name String
    Name (Must be unique and is immutable).
    savedSearchId String
    timeRange Property Map
    The RQL time range spec, as defined below.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Saved bool
    (bool) This is set to true when the saved search is created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Saved bool
    (bool) This is set to true when the saved search is created.
    id String
    The provider-assigned unique ID for this managed resource.
    saved Boolean
    (bool) This is set to true when the saved search is created.
    id string
    The provider-assigned unique ID for this managed resource.
    saved boolean
    (bool) This is set to true when the saved search is created.
    id str
    The provider-assigned unique ID for this managed resource.
    saved bool
    (bool) This is set to true when the saved search is created.
    id String
    The provider-assigned unique ID for this managed resource.
    saved Boolean
    (bool) This is set to true when the saved search is created.

    Look up Existing SavedSearch Resource

    Get an existing SavedSearch 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?: SavedSearchState, opts?: CustomResourceOptions): SavedSearch
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cloud_type: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        query: Optional[str] = None,
        saved: Optional[bool] = None,
        saved_search_id: Optional[str] = None,
        search_id: Optional[str] = None,
        time_range: Optional[SavedSearchTimeRangeArgs] = None) -> SavedSearch
    func GetSavedSearch(ctx *Context, name string, id IDInput, state *SavedSearchState, opts ...ResourceOption) (*SavedSearch, error)
    public static SavedSearch Get(string name, Input<string> id, SavedSearchState? state, CustomResourceOptions? opts = null)
    public static SavedSearch get(String name, Output<String> id, SavedSearchState state, CustomResourceOptions options)
    resources:  _:    type: prismacloud:SavedSearch    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:
    CloudType string
    Cloud type. Valid values: aws, azure, gcp, alibaba_cloud or oci.
    Description string
    Description.
    Name string
    Name (Must be unique and is immutable).
    Query string
    The RQL query.
    Saved bool
    (bool) This is set to true when the saved search is created.
    SavedSearchId string
    SearchId string
    The search ID.
    TimeRange SavedSearchTimeRange
    The RQL time range spec, as defined below.
    CloudType string
    Cloud type. Valid values: aws, azure, gcp, alibaba_cloud or oci.
    Description string
    Description.
    Name string
    Name (Must be unique and is immutable).
    Query string
    The RQL query.
    Saved bool
    (bool) This is set to true when the saved search is created.
    SavedSearchId string
    SearchId string
    The search ID.
    TimeRange SavedSearchTimeRangeArgs
    The RQL time range spec, as defined below.
    cloudType String
    Cloud type. Valid values: aws, azure, gcp, alibaba_cloud or oci.
    description String
    Description.
    name String
    Name (Must be unique and is immutable).
    query String
    The RQL query.
    saved Boolean
    (bool) This is set to true when the saved search is created.
    savedSearchId String
    searchId String
    The search ID.
    timeRange SavedSearchTimeRange
    The RQL time range spec, as defined below.
    cloudType string
    Cloud type. Valid values: aws, azure, gcp, alibaba_cloud or oci.
    description string
    Description.
    name string
    Name (Must be unique and is immutable).
    query string
    The RQL query.
    saved boolean
    (bool) This is set to true when the saved search is created.
    savedSearchId string
    searchId string
    The search ID.
    timeRange SavedSearchTimeRange
    The RQL time range spec, as defined below.
    cloud_type str
    Cloud type. Valid values: aws, azure, gcp, alibaba_cloud or oci.
    description str
    Description.
    name str
    Name (Must be unique and is immutable).
    query str
    The RQL query.
    saved bool
    (bool) This is set to true when the saved search is created.
    saved_search_id str
    search_id str
    The search ID.
    time_range SavedSearchTimeRangeArgs
    The RQL time range spec, as defined below.
    cloudType String
    Cloud type. Valid values: aws, azure, gcp, alibaba_cloud or oci.
    description String
    Description.
    name String
    Name (Must be unique and is immutable).
    query String
    The RQL query.
    saved Boolean
    (bool) This is set to true when the saved search is created.
    savedSearchId String
    searchId String
    The search ID.
    timeRange Property Map
    The RQL time range spec, as defined below.

    Supporting Types

    SavedSearchTimeRange, SavedSearchTimeRangeArgs

    Absolute SavedSearchTimeRangeAbsolute
    An absolute time range spec, as defined below.
    Relative SavedSearchTimeRangeRelative
    A relative time range spec, as defined below.
    ToNow SavedSearchTimeRangeToNow
    A "To Now" time range spec, as defined below.
    Absolute SavedSearchTimeRangeAbsolute
    An absolute time range spec, as defined below.
    Relative SavedSearchTimeRangeRelative
    A relative time range spec, as defined below.
    ToNow SavedSearchTimeRangeToNow
    A "To Now" time range spec, as defined below.
    absolute SavedSearchTimeRangeAbsolute
    An absolute time range spec, as defined below.
    relative SavedSearchTimeRangeRelative
    A relative time range spec, as defined below.
    toNow SavedSearchTimeRangeToNow
    A "To Now" time range spec, as defined below.
    absolute SavedSearchTimeRangeAbsolute
    An absolute time range spec, as defined below.
    relative SavedSearchTimeRangeRelative
    A relative time range spec, as defined below.
    toNow SavedSearchTimeRangeToNow
    A "To Now" time range spec, as defined below.
    absolute SavedSearchTimeRangeAbsolute
    An absolute time range spec, as defined below.
    relative SavedSearchTimeRangeRelative
    A relative time range spec, as defined below.
    to_now SavedSearchTimeRangeToNow
    A "To Now" time range spec, as defined below.
    absolute Property Map
    An absolute time range spec, as defined below.
    relative Property Map
    A relative time range spec, as defined below.
    toNow Property Map
    A "To Now" time range spec, as defined below.

    SavedSearchTimeRangeAbsolute, SavedSearchTimeRangeAbsoluteArgs

    End double
    End time
    Start double
    Start time
    End float64
    End time
    Start float64
    Start time
    end Double
    End time
    start Double
    Start time
    end number
    End time
    start number
    Start time
    end float
    End time
    start float
    Start time
    end Number
    End time
    start Number
    Start time

    SavedSearchTimeRangeRelative, SavedSearchTimeRangeRelativeArgs

    Amount double
    The time number
    Unit string
    The time unit
    Amount float64
    The time number
    Unit string
    The time unit
    amount Double
    The time number
    unit String
    The time unit
    amount number
    The time number
    unit string
    The time unit
    amount float
    The time number
    unit str
    The time unit
    amount Number
    The time number
    unit String
    The time unit

    SavedSearchTimeRangeToNow, SavedSearchTimeRangeToNowArgs

    Unit string
    The time unit
    Unit string
    The time unit
    unit String
    The time unit
    unit string
    The time unit
    unit str
    The time unit
    unit String
    The time unit

    Package Details

    Repository
    prismacloud paloaltonetworks/terraform-provider-prismacloud
    License
    Notes
    This Pulumi package is based on the prismacloud Terraform Provider.
    prismacloud logo
    prismacloud 1.7.0 published on Monday, Apr 14, 2025 by paloaltonetworks
    paloaltonetworks/terraform-provider-prismacloud