RecommendationEngine class

Vertex AI Search recommendation apps.

To get more information about RecommendationEngine, see:

• API documentation
• How-to Guides
• Create a Recommendation Engine

Example Usage

Discoveryengine Recommendationengine Generic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const generic = new gcp.discoveryengine.DataStore("generic", {
    location: "global",
    dataStoreId: "recommendation-datastore-id",
    displayName: "tf-test-structured-datastore",
    industryVertical: "GENERIC",
    contentConfig: "NO_CONTENT",
    solutionTypes: ["SOLUTION_TYPE_RECOMMENDATION"],
    createAdvancedSiteSearch: false,
    skipDefaultSchemaCreation: false,
});
const genericRecommendationEngine = new gcp.discoveryengine.RecommendationEngine("generic", {
    engineId: "recommendation-engine-id",
    location: generic.location,
    displayName: "Example Recommendation Engine",
    dataStoreIds: [generic.dataStoreId],
    industryVertical: "GENERIC",
    commonConfig: {
        companyName: "test-company",
    },
});

import pulumi
import pulumi_gcp as gcp

generic = gcp.discoveryengine.DataStore("generic",
    location="global",
    data_store_id="recommendation-datastore-id",
    display_name="tf-test-structured-datastore",
    industry_vertical="GENERIC",
    content_config="NO_CONTENT",
    solution_types=["SOLUTION_TYPE_RECOMMENDATION"],
    create_advanced_site_search=False,
    skip_default_schema_creation=False)
generic_recommendation_engine = gcp.discoveryengine.RecommendationEngine("generic",
    engine_id="recommendation-engine-id",
    location=generic.location,
    display_name="Example Recommendation Engine",
    data_store_ids=[generic.data_store_id],
    industry_vertical="GENERIC",
    common_config={
        "company_name": "test-company",
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var generic = new Gcp.DiscoveryEngine.DataStore("generic", new()
    {
        Location = "global",
        DataStoreId = "recommendation-datastore-id",
        DisplayName = "tf-test-structured-datastore",
        IndustryVertical = "GENERIC",
        ContentConfig = "NO_CONTENT",
        SolutionTypes = new[]
        {
            "SOLUTION_TYPE_RECOMMENDATION",
        },
        CreateAdvancedSiteSearch = false,
        SkipDefaultSchemaCreation = false,
    });

    var genericRecommendationEngine = new Gcp.DiscoveryEngine.RecommendationEngine("generic", new()
    {
        EngineId = "recommendation-engine-id",
        Location = generic.Location,
        DisplayName = "Example Recommendation Engine",
        DataStoreIds = new[]
        {
            generic.DataStoreId,
        },
        IndustryVertical = "GENERIC",
        CommonConfig = new Gcp.DiscoveryEngine.Inputs.RecommendationEngineCommonConfigArgs
        {
            CompanyName = "test-company",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/discoveryengine"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		generic, err := discoveryengine.NewDataStore(ctx, "generic", &discoveryengine.DataStoreArgs{
			Location:         pulumi.String("global"),
			DataStoreId:      pulumi.String("recommendation-datastore-id"),
			DisplayName:      pulumi.String("tf-test-structured-datastore"),
			IndustryVertical: pulumi.String("GENERIC"),
			ContentConfig:    pulumi.String("NO_CONTENT"),
			SolutionTypes: pulumi.StringArray{
				pulumi.String("SOLUTION_TYPE_RECOMMENDATION"),
			},
			CreateAdvancedSiteSearch:  pulumi.Bool(false),
			SkipDefaultSchemaCreation: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		_, err = discoveryengine.NewRecommendationEngine(ctx, "generic", &discoveryengine.RecommendationEngineArgs{
			EngineId:    pulumi.String("recommendation-engine-id"),
			Location:    generic.Location,
			DisplayName: pulumi.String("Example Recommendation Engine"),
			DataStoreIds: pulumi.StringArray{
				generic.DataStoreId,
			},
			IndustryVertical: pulumi.String("GENERIC"),
			CommonConfig: &discoveryengine.RecommendationEngineCommonConfigArgs{
				CompanyName: pulumi.String("test-company"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_discoveryengine_datastore" "generic" {
  location                     = "global"
  data_store_id                = "recommendation-datastore-id"
  display_name                 = "tf-test-structured-datastore"
  industry_vertical            = "GENERIC"
  content_config               = "NO_CONTENT"
  solution_types               = ["SOLUTION_TYPE_RECOMMENDATION"]
  create_advanced_site_search  = false
  skip_default_schema_creation = false
}
resource "gcp_discoveryengine_recommendationengine" "generic" {
  engine_id         = "recommendation-engine-id"
  location          = gcp_discoveryengine_datastore.generic.location
  display_name      = "Example Recommendation Engine"
  data_store_ids    = [gcp_discoveryengine_datastore.generic.data_store_id]
  industry_vertical = "GENERIC"
  common_config = {
    company_name = "test-company"
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.discoveryengine.DataStore;
import com.pulumi.gcp.discoveryengine.DataStoreArgs;
import com.pulumi.gcp.discoveryengine.RecommendationEngine;
import com.pulumi.gcp.discoveryengine.RecommendationEngineArgs;
import com.pulumi.gcp.discoveryengine.inputs.RecommendationEngineCommonConfigArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var generic = new DataStore("generic", DataStoreArgs.builder()
            .location("global")
            .dataStoreId("recommendation-datastore-id")
            .displayName("tf-test-structured-datastore")
            .industryVertical("GENERIC")
            .contentConfig("NO_CONTENT")
            .solutionTypes("SOLUTION_TYPE_RECOMMENDATION")
            .createAdvancedSiteSearch(false)
            .skipDefaultSchemaCreation(false)
            .build());

        var genericRecommendationEngine = new RecommendationEngine("genericRecommendationEngine", RecommendationEngineArgs.builder()
            .engineId("recommendation-engine-id")
            .location(generic.location())
            .displayName("Example Recommendation Engine")
            .dataStoreIds(generic.dataStoreId())
            .industryVertical("GENERIC")
            .commonConfig(RecommendationEngineCommonConfigArgs.builder()
                .companyName("test-company")
                .build())
            .build());

    }
}

resources:
  generic:
    type: gcp:discoveryengine:DataStore
    properties:
      location: global
      dataStoreId: recommendation-datastore-id
      displayName: tf-test-structured-datastore
      industryVertical: GENERIC
      contentConfig: NO_CONTENT
      solutionTypes:
        - SOLUTION_TYPE_RECOMMENDATION
      createAdvancedSiteSearch: false
      skipDefaultSchemaCreation: false
  genericRecommendationEngine:
    type: gcp:discoveryengine:RecommendationEngine
    name: generic
    properties:
      engineId: recommendation-engine-id
      location: ${generic.location}
      displayName: Example Recommendation Engine
      dataStoreIds:
        - ${generic.dataStoreId}
      industryVertical: GENERIC
      commonConfig:
        companyName: test-company

Discoveryengine Recommendationengine Media

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const media = new gcp.discoveryengine.DataStore("media", {
    location: "global",
    dataStoreId: "recommendation-datastore-id",
    displayName: "tf-test-structured-datastore",
    industryVertical: "MEDIA",
    contentConfig: "NO_CONTENT",
    solutionTypes: ["SOLUTION_TYPE_RECOMMENDATION"],
    createAdvancedSiteSearch: false,
    skipDefaultSchemaCreation: false,
});
const mediaRecommendationEngine = new gcp.discoveryengine.RecommendationEngine("media", {
    engineId: "recommendation-engine-id",
    location: media.location,
    displayName: "Example Media Recommendation Engine",
    dataStoreIds: [media.dataStoreId],
    industryVertical: "MEDIA",
    mediaRecommendationEngineConfig: {
        type: "recommended-for-you",
        optimizationObjective: "ctr",
        trainingState: "PAUSED",
        engineFeaturesConfig: {
            recommendedForYouConfig: {
                contextEventType: "generic",
            },
        },
    },
    commonConfig: {
        companyName: "test-company",
    },
});

import pulumi
import pulumi_gcp as gcp

media = gcp.discoveryengine.DataStore("media",
    location="global",
    data_store_id="recommendation-datastore-id",
    display_name="tf-test-structured-datastore",
    industry_vertical="MEDIA",
    content_config="NO_CONTENT",
    solution_types=["SOLUTION_TYPE_RECOMMENDATION"],
    create_advanced_site_search=False,
    skip_default_schema_creation=False)
media_recommendation_engine = gcp.discoveryengine.RecommendationEngine("media",
    engine_id="recommendation-engine-id",
    location=media.location,
    display_name="Example Media Recommendation Engine",
    data_store_ids=[media.data_store_id],
    industry_vertical="MEDIA",
    media_recommendation_engine_config={
        "type": "recommended-for-you",
        "optimization_objective": "ctr",
        "training_state": "PAUSED",
        "engine_features_config": {
            "recommended_for_you_config": {
                "context_event_type": "generic",
            },
        },
    },
    common_config={
        "company_name": "test-company",
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var media = new Gcp.DiscoveryEngine.DataStore("media", new()
    {
        Location = "global",
        DataStoreId = "recommendation-datastore-id",
        DisplayName = "tf-test-structured-datastore",
        IndustryVertical = "MEDIA",
        ContentConfig = "NO_CONTENT",
        SolutionTypes = new[]
        {
            "SOLUTION_TYPE_RECOMMENDATION",
        },
        CreateAdvancedSiteSearch = false,
        SkipDefaultSchemaCreation = false,
    });

    var mediaRecommendationEngine = new Gcp.DiscoveryEngine.RecommendationEngine("media", new()
    {
        EngineId = "recommendation-engine-id",
        Location = media.Location,
        DisplayName = "Example Media Recommendation Engine",
        DataStoreIds = new[]
        {
            media.DataStoreId,
        },
        IndustryVertical = "MEDIA",
        MediaRecommendationEngineConfig = new Gcp.DiscoveryEngine.Inputs.RecommendationEngineMediaRecommendationEngineConfigArgs
        {
            Type = "recommended-for-you",
            OptimizationObjective = "ctr",
            TrainingState = "PAUSED",
            EngineFeaturesConfig = new Gcp.DiscoveryEngine.Inputs.RecommendationEngineMediaRecommendationEngineConfigEngineFeaturesConfigArgs
            {
                RecommendedForYouConfig = new Gcp.DiscoveryEngine.Inputs.RecommendationEngineMediaRecommendationEngineConfigEngineFeaturesConfigRecommendedForYouConfigArgs
                {
                    ContextEventType = "generic",
                },
            },
        },
        CommonConfig = new Gcp.DiscoveryEngine.Inputs.RecommendationEngineCommonConfigArgs
        {
            CompanyName = "test-company",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/discoveryengine"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		media, err := discoveryengine.NewDataStore(ctx, "media", &discoveryengine.DataStoreArgs{
			Location:         pulumi.String("global"),
			DataStoreId:      pulumi.String("recommendation-datastore-id"),
			DisplayName:      pulumi.String("tf-test-structured-datastore"),
			IndustryVertical: pulumi.String("MEDIA"),
			ContentConfig:    pulumi.String("NO_CONTENT"),
			SolutionTypes: pulumi.StringArray{
				pulumi.String("SOLUTION_TYPE_RECOMMENDATION"),
			},
			CreateAdvancedSiteSearch:  pulumi.Bool(false),
			SkipDefaultSchemaCreation: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		_, err = discoveryengine.NewRecommendationEngine(ctx, "media", &discoveryengine.RecommendationEngineArgs{
			EngineId:    pulumi.String("recommendation-engine-id"),
			Location:    media.Location,
			DisplayName: pulumi.String("Example Media Recommendation Engine"),
			DataStoreIds: pulumi.StringArray{
				media.DataStoreId,
			},
			IndustryVertical: pulumi.String("MEDIA"),
			MediaRecommendationEngineConfig: &discoveryengine.RecommendationEngineMediaRecommendationEngineConfigArgs{
				Type:                  pulumi.String("recommended-for-you"),
				OptimizationObjective: pulumi.String("ctr"),
				TrainingState:         pulumi.String("PAUSED"),
				EngineFeaturesConfig: &discoveryengine.RecommendationEngineMediaRecommendationEngineConfigEngineFeaturesConfigArgs{
					RecommendedForYouConfig: &discoveryengine.RecommendationEngineMediaRecommendationEngineConfigEngineFeaturesConfigRecommendedForYouConfigArgs{
						ContextEventType: pulumi.String("generic"),
					},
				},
			},
			CommonConfig: &discoveryengine.RecommendationEngineCommonConfigArgs{
				CompanyName: pulumi.String("test-company"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_discoveryengine_datastore" "media" {
  location                     = "global"
  data_store_id                = "recommendation-datastore-id"
  display_name                 = "tf-test-structured-datastore"
  industry_vertical            = "MEDIA"
  content_config               = "NO_CONTENT"
  solution_types               = ["SOLUTION_TYPE_RECOMMENDATION"]
  create_advanced_site_search  = false
  skip_default_schema_creation = false
}
resource "gcp_discoveryengine_recommendationengine" "media" {
  engine_id         = "recommendation-engine-id"
  location          = gcp_discoveryengine_datastore.media.location
  display_name      = "Example Media Recommendation Engine"
  data_store_ids    = [gcp_discoveryengine_datastore.media.data_store_id]
  industry_vertical = "MEDIA"
  media_recommendation_engine_config = {
    type                   = "recommended-for-you"
    optimization_objective = "ctr"
    training_state         = "PAUSED"
    engine_features_config = {
      recommended_for_you_config = {
        context_event_type = "generic"
      }
    }
  }
  common_config = {
    company_name = "test-company"
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.discoveryengine.DataStore;
import com.pulumi.gcp.discoveryengine.DataStoreArgs;
import com.pulumi.gcp.discoveryengine.RecommendationEngine;
import com.pulumi.gcp.discoveryengine.RecommendationEngineArgs;
import com.pulumi.gcp.discoveryengine.inputs.RecommendationEngineMediaRecommendationEngineConfigArgs;
import com.pulumi.gcp.discoveryengine.inputs.RecommendationEngineMediaRecommendationEngineConfigEngineFeaturesConfigArgs;
import com.pulumi.gcp.discoveryengine.inputs.RecommendationEngineMediaRecommendationEngineConfigEngineFeaturesConfigRecommendedForYouConfigArgs;
import com.pulumi.gcp.discoveryengine.inputs.RecommendationEngineCommonConfigArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var media = new DataStore("media", DataStoreArgs.builder()
            .location("global")
            .dataStoreId("recommendation-datastore-id")
            .displayName("tf-test-structured-datastore")
            .industryVertical("MEDIA")
            .contentConfig("NO_CONTENT")
            .solutionTypes("SOLUTION_TYPE_RECOMMENDATION")
            .createAdvancedSiteSearch(false)
            .skipDefaultSchemaCreation(false)
            .build());

        var mediaRecommendationEngine = new RecommendationEngine("mediaRecommendationEngine", RecommendationEngineArgs.builder()
            .engineId("recommendation-engine-id")
            .location(media.location())
            .displayName("Example Media Recommendation Engine")
            .dataStoreIds(media.dataStoreId())
            .industryVertical("MEDIA")
            .mediaRecommendationEngineConfig(RecommendationEngineMediaRecommendationEngineConfigArgs.builder()
                .type("recommended-for-you")
                .optimizationObjective("ctr")
                .trainingState("PAUSED")
                .engineFeaturesConfig(RecommendationEngineMediaRecommendationEngineConfigEngineFeaturesConfigArgs.builder()
                    .recommendedForYouConfig(RecommendationEngineMediaRecommendationEngineConfigEngineFeaturesConfigRecommendedForYouConfigArgs.builder()
                        .contextEventType("generic")
                        .build())
                    .build())
                .build())
            .commonConfig(RecommendationEngineCommonConfigArgs.builder()
                .companyName("test-company")
                .build())
            .build());

    }
}

resources:
  media:
    type: gcp:discoveryengine:DataStore
    properties:
      location: global
      dataStoreId: recommendation-datastore-id
      displayName: tf-test-structured-datastore
      industryVertical: MEDIA
      contentConfig: NO_CONTENT
      solutionTypes:
        - SOLUTION_TYPE_RECOMMENDATION
      createAdvancedSiteSearch: false
      skipDefaultSchemaCreation: false
  mediaRecommendationEngine:
    type: gcp:discoveryengine:RecommendationEngine
    name: media
    properties:
      engineId: recommendation-engine-id
      location: ${media.location}
      displayName: Example Media Recommendation Engine
      dataStoreIds:
        - ${media.dataStoreId}
      industryVertical: MEDIA
      mediaRecommendationEngineConfig:
        type: recommended-for-you
        optimizationObjective: ctr
        trainingState: PAUSED
        engineFeaturesConfig:
          recommendedForYouConfig:
            contextEventType: generic
      commonConfig:
        companyName: test-company

Import

RecommendationEngine can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/collections/default_collection/engines/{{engine_id}}
• {{project}}/{{location}}/{{engine_id}}
• {{location}}/{{engine_id}}

When using the pulumi import command, RecommendationEngine can be imported using one of the formats above. For example:

$ pulumi import gcp:discoveryengine/recommendationEngine:RecommendationEngine default projects/{{project}}/locations/{{location}}/collections/default_collection/engines/{{engine_id}}
$ pulumi import gcp:discoveryengine/recommendationEngine:RecommendationEngine default {{project}}/{{location}}/{{engine_id}}
$ pulumi import gcp:discoveryengine/recommendationEngine:RecommendationEngine default {{location}}/{{engine_id}}

Constructors

RecommendationEngine(String name, {RecommendationEngineArgs? args, CustomResourceOptions? options})

Creates a new RecommendationEngine. name The Pulumi resource name. args Arguments used to configure this RecommendationEngine. The set of arguments for RecommendationEngine. options Resource options controlling this resource's behavior.

RecommendationEngine.reference(String urn)

Creates a typed reference to an existing RecommendationEngine resource.

Properties

childResources → Set<Resource>

final, inherited

commonConfig ↔ Output<RecommendationEngineCommonConfig?>

Common config spec that specifies the metadata of the engine. Structure is documented below.

late, final

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

Timestamp the Engine was created at.

late, final

dataStoreIds ↔ Output<List<String>>

The data stores associated with this engine. For SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store.

late, final

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

displayName ↔ Output<String>

Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.

late, final

engineId ↔ Output<String>

Unique ID to use for Recommendation Engine.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

industryVertical ↔ Output<String?>

The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to GENERIC. Vertical on Engine has to match vertical of the DataStore liniked to the engine. Default value is GENERIC. Possible values are: GENERIC, MEDIA.

late, final

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

location ↔ Output<String>

The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".

late, final

mediaRecommendationEngineConfig ↔ Output<RecommendationEngineMediaRecommendationEngineConfig?>

Configurations for a Media Recommendation Engine. Only applicable on the data stores with SOLUTION_TYPE_RECOMMENDATION solution type and MEDIA industry vertical. Structure is documented below.

late, final

name ↔ Output<String>

The unique full resource name of the recommendation engine. Values are of the format projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

updateTime ↔ Output<String>

Timestamp the Engine was last updated.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {RecommendationEngineState? state, CustomResourceOptions? options}) → RecommendationEngine

Gets an existing RecommendationEngine resource's state with the given name and id.