1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. diagflow
  5. Environment
Viewing docs for Google Cloud v9.17.0
published on Tuesday, Mar 31, 2026 by Pulumi
gcp logo
Viewing docs for Google Cloud v9.17.0
published on Tuesday, Mar 31, 2026 by Pulumi

    Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments.

    To get more information about Environment, see:

    Example Usage

    Dialogflow Environment Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    import * as time from "@pulumiverse/time";
    
    const project = new gcp.organizations.Project("project", {
        projectId: "my-proj",
        name: "my-proj",
        orgId: "123456789",
        billingAccount: "000000-0000000-0000000-000000",
        deletionPolicy: "DELETE",
    });
    const dialogflow = new gcp.projects.Service("dialogflow", {
        project: project.projectId,
        service: "dialogflow.googleapis.com",
    });
    const waitEnableServiceApi = new time.Sleep("wait_enable_service_api", {createDuration: "30s"}, {
        dependsOn: [dialogflow],
    });
    const gcpSa = new gcp.projects.ServiceIdentity("gcp_sa", {
        service: "dialogflow.googleapis.com",
        project: project.projectId,
    }, {
        dependsOn: [waitEnableServiceApi],
    });
    const basicAgent = new gcp.diagflow.Agent("basic_agent", {
        displayName: "example_agent",
        defaultLanguageCode: "en-us",
        timeZone: "America/New_York",
        project: project.projectId,
    }, {
        dependsOn: [waitEnableServiceApi],
    });
    const version = new gcp.diagflow.Version("version", {
        description: "Dialogflow Version",
        parent: pulumi.interpolate`projects/${project.projectId}/agent`,
    }, {
        dependsOn: [basicAgent],
    });
    const basicEnvironment = new gcp.diagflow.Environment("basic_environment", {
        project: project.projectId,
        environmentid: "basic-environment",
        description: "basic environment",
        agentVersion: pulumi.interpolate`projects/${project.projectId}/locations/global/agent/versions/${version.name}`,
    }, {
        dependsOn: [basicAgent],
    });
    
    import pulumi
    import pulumi_gcp as gcp
    import pulumiverse_time as time
    
    project = gcp.organizations.Project("project",
        project_id="my-proj",
        name="my-proj",
        org_id="123456789",
        billing_account="000000-0000000-0000000-000000",
        deletion_policy="DELETE")
    dialogflow = gcp.projects.Service("dialogflow",
        project=project.project_id,
        service="dialogflow.googleapis.com")
    wait_enable_service_api = time.Sleep("wait_enable_service_api", create_duration="30s",
    opts = pulumi.ResourceOptions(depends_on=[dialogflow]))
    gcp_sa = gcp.projects.ServiceIdentity("gcp_sa",
        service="dialogflow.googleapis.com",
        project=project.project_id,
        opts = pulumi.ResourceOptions(depends_on=[wait_enable_service_api]))
    basic_agent = gcp.diagflow.Agent("basic_agent",
        display_name="example_agent",
        default_language_code="en-us",
        time_zone="America/New_York",
        project=project.project_id,
        opts = pulumi.ResourceOptions(depends_on=[wait_enable_service_api]))
    version = gcp.diagflow.Version("version",
        description="Dialogflow Version",
        parent=project.project_id.apply(lambda project_id: f"projects/{project_id}/agent"),
        opts = pulumi.ResourceOptions(depends_on=[basic_agent]))
    basic_environment = gcp.diagflow.Environment("basic_environment",
        project=project.project_id,
        environmentid="basic-environment",
        description="basic environment",
        agent_version=pulumi.Output.all(
            project_id=project.project_id,
            name=version.name
    ).apply(lambda resolved_outputs: f"projects/{resolved_outputs['project_id']}/locations/global/agent/versions/{resolved_outputs['name']}")
    ,
        opts = pulumi.ResourceOptions(depends_on=[basic_agent]))
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/diagflow"
    	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/organizations"
    	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/projects"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-time/sdk/go/time"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		project, err := organizations.NewProject(ctx, "project", &organizations.ProjectArgs{
    			ProjectId:      pulumi.String("my-proj"),
    			Name:           pulumi.String("my-proj"),
    			OrgId:          pulumi.String("123456789"),
    			BillingAccount: pulumi.String("000000-0000000-0000000-000000"),
    			DeletionPolicy: pulumi.String("DELETE"),
    		})
    		if err != nil {
    			return err
    		}
    		dialogflow, err := projects.NewService(ctx, "dialogflow", &projects.ServiceArgs{
    			Project: project.ProjectId,
    			Service: pulumi.String("dialogflow.googleapis.com"),
    		})
    		if err != nil {
    			return err
    		}
    		waitEnableServiceApi, err := time.NewSleep(ctx, "wait_enable_service_api", &time.SleepArgs{
    			CreateDuration: pulumi.String("30s"),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			dialogflow,
    		}))
    		if err != nil {
    			return err
    		}
    		_, err = projects.NewServiceIdentity(ctx, "gcp_sa", &projects.ServiceIdentityArgs{
    			Service: pulumi.String("dialogflow.googleapis.com"),
    			Project: project.ProjectId,
    		}, pulumi.DependsOn([]pulumi.Resource{
    			waitEnableServiceApi,
    		}))
    		if err != nil {
    			return err
    		}
    		basicAgent, err := diagflow.NewAgent(ctx, "basic_agent", &diagflow.AgentArgs{
    			DisplayName:         pulumi.String("example_agent"),
    			DefaultLanguageCode: pulumi.String("en-us"),
    			TimeZone:            pulumi.String("America/New_York"),
    			Project:             project.ProjectId,
    		}, pulumi.DependsOn([]pulumi.Resource{
    			waitEnableServiceApi,
    		}))
    		if err != nil {
    			return err
    		}
    		version, err := diagflow.NewVersion(ctx, "version", &diagflow.VersionArgs{
    			Description: pulumi.String("Dialogflow Version"),
    			Parent: project.ProjectId.ApplyT(func(projectId string) (string, error) {
    				return fmt.Sprintf("projects/%v/agent", projectId), nil
    			}).(pulumi.StringOutput),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			basicAgent,
    		}))
    		if err != nil {
    			return err
    		}
    		_, err = diagflow.NewEnvironment(ctx, "basic_environment", &diagflow.EnvironmentArgs{
    			Project:       project.ProjectId,
    			Environmentid: pulumi.String("basic-environment"),
    			Description:   pulumi.String("basic environment"),
    			AgentVersion: pulumi.All(project.ProjectId, version.Name).ApplyT(func(_args []interface{}) (string, error) {
    				projectId := _args[0].(string)
    				name := _args[1].(string)
    				return fmt.Sprintf("projects/%v/locations/global/agent/versions/%v", projectId, name), nil
    			}).(pulumi.StringOutput),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			basicAgent,
    		}))
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    using Time = Pulumiverse.Time;
    
    return await Deployment.RunAsync(() => 
    {
        var project = new Gcp.Organizations.Project("project", new()
        {
            ProjectId = "my-proj",
            Name = "my-proj",
            OrgId = "123456789",
            BillingAccount = "000000-0000000-0000000-000000",
            DeletionPolicy = "DELETE",
        });
    
        var dialogflow = new Gcp.Projects.Service("dialogflow", new()
        {
            Project = project.ProjectId,
            ServiceName = "dialogflow.googleapis.com",
        });
    
        var waitEnableServiceApi = new Time.Sleep("wait_enable_service_api", new()
        {
            CreateDuration = "30s",
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                dialogflow,
            },
        });
    
        var gcpSa = new Gcp.Projects.ServiceIdentity("gcp_sa", new()
        {
            Service = "dialogflow.googleapis.com",
            Project = project.ProjectId,
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                waitEnableServiceApi,
            },
        });
    
        var basicAgent = new Gcp.Diagflow.Agent("basic_agent", new()
        {
            DisplayName = "example_agent",
            DefaultLanguageCode = "en-us",
            TimeZone = "America/New_York",
            Project = project.ProjectId,
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                waitEnableServiceApi,
            },
        });
    
        var version = new Gcp.Diagflow.Version("version", new()
        {
            Description = "Dialogflow Version",
            Parent = project.ProjectId.Apply(projectId => $"projects/{projectId}/agent"),
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                basicAgent,
            },
        });
    
        var basicEnvironment = new Gcp.Diagflow.Environment("basic_environment", new()
        {
            Project = project.ProjectId,
            Environmentid = "basic-environment",
            Description = "basic environment",
            AgentVersion = Output.Tuple(project.ProjectId, version.Name).Apply(values =>
            {
                var projectId = values.Item1;
                var name = values.Item2;
                return $"projects/{projectId}/locations/global/agent/versions/{name}";
            }),
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                basicAgent,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.organizations.Project;
    import com.pulumi.gcp.organizations.ProjectArgs;
    import com.pulumi.gcp.projects.Service;
    import com.pulumi.gcp.projects.ServiceArgs;
    import com.pulumiverse.time.Sleep;
    import com.pulumiverse.time.SleepArgs;
    import com.pulumi.gcp.projects.ServiceIdentity;
    import com.pulumi.gcp.projects.ServiceIdentityArgs;
    import com.pulumi.gcp.diagflow.Agent;
    import com.pulumi.gcp.diagflow.AgentArgs;
    import com.pulumi.gcp.diagflow.Version;
    import com.pulumi.gcp.diagflow.VersionArgs;
    import com.pulumi.gcp.diagflow.Environment;
    import com.pulumi.gcp.diagflow.EnvironmentArgs;
    import com.pulumi.resources.CustomResourceOptions;
    import java.util.List;
    import java.util.ArrayList;
    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 project = new Project("project", ProjectArgs.builder()
                .projectId("my-proj")
                .name("my-proj")
                .orgId("123456789")
                .billingAccount("000000-0000000-0000000-000000")
                .deletionPolicy("DELETE")
                .build());
    
            var dialogflow = new Service("dialogflow", ServiceArgs.builder()
                .project(project.projectId())
                .service("dialogflow.googleapis.com")
                .build());
    
            var waitEnableServiceApi = new Sleep("waitEnableServiceApi", SleepArgs.builder()
                .createDuration("30s")
                .build(), CustomResourceOptions.builder()
                    .dependsOn(dialogflow)
                    .build());
    
            var gcpSa = new ServiceIdentity("gcpSa", ServiceIdentityArgs.builder()
                .service("dialogflow.googleapis.com")
                .project(project.projectId())
                .build(), CustomResourceOptions.builder()
                    .dependsOn(waitEnableServiceApi)
                    .build());
    
            var basicAgent = new Agent("basicAgent", AgentArgs.builder()
                .displayName("example_agent")
                .defaultLanguageCode("en-us")
                .timeZone("America/New_York")
                .project(project.projectId())
                .build(), CustomResourceOptions.builder()
                    .dependsOn(waitEnableServiceApi)
                    .build());
    
            var version = new Version("version", VersionArgs.builder()
                .description("Dialogflow Version")
                .parent(project.projectId().applyValue(_projectId -> String.format("projects/%s/agent", _projectId)))
                .build(), CustomResourceOptions.builder()
                    .dependsOn(basicAgent)
                    .build());
    
            var basicEnvironment = new Environment("basicEnvironment", EnvironmentArgs.builder()
                .project(project.projectId())
                .environmentid("basic-environment")
                .description("basic environment")
                .agentVersion(Output.tuple(project.projectId(), version.name()).applyValue(values -> {
                    var projectId = values.t1;
                    var name = values.t2;
                    return String.format("projects/%s/locations/global/agent/versions/%s", projectId,name);
                }))
                .build(), CustomResourceOptions.builder()
                    .dependsOn(basicAgent)
                    .build());
    
        }
    }
    
    resources:
      project:
        type: gcp:organizations:Project
        properties:
          projectId: my-proj
          name: my-proj
          orgId: '123456789'
          billingAccount: 000000-0000000-0000000-000000
          deletionPolicy: DELETE
      dialogflow:
        type: gcp:projects:Service
        properties:
          project: ${project.projectId}
          service: dialogflow.googleapis.com
      waitEnableServiceApi:
        type: time:Sleep
        name: wait_enable_service_api
        properties:
          createDuration: 30s
        options:
          dependsOn:
            - ${dialogflow}
      gcpSa:
        type: gcp:projects:ServiceIdentity
        name: gcp_sa
        properties:
          service: dialogflow.googleapis.com
          project: ${project.projectId}
        options:
          dependsOn:
            - ${waitEnableServiceApi}
      basicAgent:
        type: gcp:diagflow:Agent
        name: basic_agent
        properties:
          displayName: example_agent
          defaultLanguageCode: en-us
          timeZone: America/New_York
          project: ${project.projectId}
        options:
          dependsOn:
            - ${waitEnableServiceApi}
      version:
        type: gcp:diagflow:Version
        properties:
          description: Dialogflow Version
          parent: projects/${project.projectId}/agent
        options:
          dependsOn:
            - ${basicAgent}
      basicEnvironment:
        type: gcp:diagflow:Environment
        name: basic_environment
        properties:
          project: ${project.projectId}
          environmentid: basic-environment
          description: basic environment
          agentVersion: projects/${project.projectId}/locations/global/agent/versions/${version.name}
        options:
          dependsOn:
            - ${basicAgent}
    

    Create Environment Resource

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

    Constructor syntax

    new Environment(name: string, args: EnvironmentArgs, opts?: CustomResourceOptions);
    @overload
    def Environment(resource_name: str,
                    args: EnvironmentArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def Environment(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    environmentid: Optional[str] = None,
                    agent_version: Optional[str] = None,
                    description: Optional[str] = None,
                    fulfillment: Optional[EnvironmentFulfillmentArgs] = None,
                    location: Optional[str] = None,
                    project: Optional[str] = None,
                    text_to_speech_settings: Optional[EnvironmentTextToSpeechSettingsArgs] = None)
    func NewEnvironment(ctx *Context, name string, args EnvironmentArgs, opts ...ResourceOption) (*Environment, error)
    public Environment(string name, EnvironmentArgs args, CustomResourceOptions? opts = null)
    public Environment(String name, EnvironmentArgs args)
    public Environment(String name, EnvironmentArgs args, CustomResourceOptions options)
    
    type: gcp:diagflow:Environment
    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 EnvironmentArgs
    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 EnvironmentArgs
    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 EnvironmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnvironmentArgs
    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 exampleenvironmentResourceResourceFromDiagflowenvironment = new Gcp.Diagflow.Environment("exampleenvironmentResourceResourceFromDiagflowenvironment", new()
    {
        Environmentid = "string",
        AgentVersion = "string",
        Description = "string",
        Fulfillment = new Gcp.Diagflow.Inputs.EnvironmentFulfillmentArgs
        {
            DisplayName = "string",
            Features = new[]
            {
                new Gcp.Diagflow.Inputs.EnvironmentFulfillmentFeatureArgs
                {
                    Type = "string",
                },
            },
            GenericWebService = new Gcp.Diagflow.Inputs.EnvironmentFulfillmentGenericWebServiceArgs
            {
                Uri = "string",
                Password = "string",
                RequestHeaders = 
                {
                    { "string", "string" },
                },
                Username = "string",
            },
            Name = "string",
        },
        Location = "string",
        Project = "string",
        TextToSpeechSettings = new Gcp.Diagflow.Inputs.EnvironmentTextToSpeechSettingsArgs
        {
            EnableTextToSpeech = false,
            OutputAudioEncoding = "string",
            SampleRateHertz = 0,
            SynthesizeSpeechConfigs = new[]
            {
                new Gcp.Diagflow.Inputs.EnvironmentTextToSpeechSettingsSynthesizeSpeechConfigArgs
                {
                    Language = "string",
                    EffectsProfileIds = new[]
                    {
                        "string",
                    },
                    Pitch = 0,
                    SpeakingRate = 0,
                    Voice = new Gcp.Diagflow.Inputs.EnvironmentTextToSpeechSettingsSynthesizeSpeechConfigVoiceArgs
                    {
                        Name = "string",
                        SsmlGender = "string",
                    },
                    VolumeGainDb = 0,
                },
            },
        },
    });
    
    example, err := diagflow.NewEnvironment(ctx, "exampleenvironmentResourceResourceFromDiagflowenvironment", &diagflow.EnvironmentArgs{
    	Environmentid: pulumi.String("string"),
    	AgentVersion:  pulumi.String("string"),
    	Description:   pulumi.String("string"),
    	Fulfillment: &diagflow.EnvironmentFulfillmentArgs{
    		DisplayName: pulumi.String("string"),
    		Features: diagflow.EnvironmentFulfillmentFeatureArray{
    			&diagflow.EnvironmentFulfillmentFeatureArgs{
    				Type: pulumi.String("string"),
    			},
    		},
    		GenericWebService: &diagflow.EnvironmentFulfillmentGenericWebServiceArgs{
    			Uri:      pulumi.String("string"),
    			Password: pulumi.String("string"),
    			RequestHeaders: pulumi.StringMap{
    				"string": pulumi.String("string"),
    			},
    			Username: pulumi.String("string"),
    		},
    		Name: pulumi.String("string"),
    	},
    	Location: pulumi.String("string"),
    	Project:  pulumi.String("string"),
    	TextToSpeechSettings: &diagflow.EnvironmentTextToSpeechSettingsArgs{
    		EnableTextToSpeech:  pulumi.Bool(false),
    		OutputAudioEncoding: pulumi.String("string"),
    		SampleRateHertz:     pulumi.Int(0),
    		SynthesizeSpeechConfigs: diagflow.EnvironmentTextToSpeechSettingsSynthesizeSpeechConfigArray{
    			&diagflow.EnvironmentTextToSpeechSettingsSynthesizeSpeechConfigArgs{
    				Language: pulumi.String("string"),
    				EffectsProfileIds: pulumi.StringArray{
    					pulumi.String("string"),
    				},
    				Pitch:        pulumi.Float64(0),
    				SpeakingRate: pulumi.Float64(0),
    				Voice: &diagflow.EnvironmentTextToSpeechSettingsSynthesizeSpeechConfigVoiceArgs{
    					Name:       pulumi.String("string"),
    					SsmlGender: pulumi.String("string"),
    				},
    				VolumeGainDb: pulumi.Float64(0),
    			},
    		},
    	},
    })
    
    var exampleenvironmentResourceResourceFromDiagflowenvironment = new com.pulumi.gcp.diagflow.Environment("exampleenvironmentResourceResourceFromDiagflowenvironment", com.pulumi.gcp.diagflow.EnvironmentArgs.builder()
        .environmentid("string")
        .agentVersion("string")
        .description("string")
        .fulfillment(EnvironmentFulfillmentArgs.builder()
            .displayName("string")
            .features(EnvironmentFulfillmentFeatureArgs.builder()
                .type("string")
                .build())
            .genericWebService(EnvironmentFulfillmentGenericWebServiceArgs.builder()
                .uri("string")
                .password("string")
                .requestHeaders(Map.of("string", "string"))
                .username("string")
                .build())
            .name("string")
            .build())
        .location("string")
        .project("string")
        .textToSpeechSettings(EnvironmentTextToSpeechSettingsArgs.builder()
            .enableTextToSpeech(false)
            .outputAudioEncoding("string")
            .sampleRateHertz(0)
            .synthesizeSpeechConfigs(EnvironmentTextToSpeechSettingsSynthesizeSpeechConfigArgs.builder()
                .language("string")
                .effectsProfileIds("string")
                .pitch(0.0)
                .speakingRate(0.0)
                .voice(EnvironmentTextToSpeechSettingsSynthesizeSpeechConfigVoiceArgs.builder()
                    .name("string")
                    .ssmlGender("string")
                    .build())
                .volumeGainDb(0.0)
                .build())
            .build())
        .build());
    
    exampleenvironment_resource_resource_from_diagflowenvironment = gcp.diagflow.Environment("exampleenvironmentResourceResourceFromDiagflowenvironment",
        environmentid="string",
        agent_version="string",
        description="string",
        fulfillment={
            "display_name": "string",
            "features": [{
                "type": "string",
            }],
            "generic_web_service": {
                "uri": "string",
                "password": "string",
                "request_headers": {
                    "string": "string",
                },
                "username": "string",
            },
            "name": "string",
        },
        location="string",
        project="string",
        text_to_speech_settings={
            "enable_text_to_speech": False,
            "output_audio_encoding": "string",
            "sample_rate_hertz": 0,
            "synthesize_speech_configs": [{
                "language": "string",
                "effects_profile_ids": ["string"],
                "pitch": 0,
                "speaking_rate": 0,
                "voice": {
                    "name": "string",
                    "ssml_gender": "string",
                },
                "volume_gain_db": 0,
            }],
        })
    
    const exampleenvironmentResourceResourceFromDiagflowenvironment = new gcp.diagflow.Environment("exampleenvironmentResourceResourceFromDiagflowenvironment", {
        environmentid: "string",
        agentVersion: "string",
        description: "string",
        fulfillment: {
            displayName: "string",
            features: [{
                type: "string",
            }],
            genericWebService: {
                uri: "string",
                password: "string",
                requestHeaders: {
                    string: "string",
                },
                username: "string",
            },
            name: "string",
        },
        location: "string",
        project: "string",
        textToSpeechSettings: {
            enableTextToSpeech: false,
            outputAudioEncoding: "string",
            sampleRateHertz: 0,
            synthesizeSpeechConfigs: [{
                language: "string",
                effectsProfileIds: ["string"],
                pitch: 0,
                speakingRate: 0,
                voice: {
                    name: "string",
                    ssmlGender: "string",
                },
                volumeGainDb: 0,
            }],
        },
    });
    
    type: gcp:diagflow:Environment
    properties:
        agentVersion: string
        description: string
        environmentid: string
        fulfillment:
            displayName: string
            features:
                - type: string
            genericWebService:
                password: string
                requestHeaders:
                    string: string
                uri: string
                username: string
            name: string
        location: string
        project: string
        textToSpeechSettings:
            enableTextToSpeech: false
            outputAudioEncoding: string
            sampleRateHertz: 0
            synthesizeSpeechConfigs:
                - effectsProfileIds:
                    - string
                  language: string
                  pitch: 0
                  speakingRate: 0
                  voice:
                    name: string
                    ssmlGender: string
                  volumeGainDb: 0
    

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

    Environmentid string
    (Required)
    AgentVersion string
    The agent version loaded into this environment. Supported formats:

    • projects//agent/versions/
    • projects//locations//agent/versions/
    Description string
    The developer-provided description for this environment.
    Fulfillment EnvironmentFulfillment
    desc Structure is documented below.
    Location string
    (Optional)
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    TextToSpeechSettings EnvironmentTextToSpeechSettings
    Text to speech settings for this environment. Structure is documented below.
    Environmentid string
    (Required)
    AgentVersion string
    The agent version loaded into this environment. Supported formats:

    • projects//agent/versions/
    • projects//locations//agent/versions/
    Description string
    The developer-provided description for this environment.
    Fulfillment EnvironmentFulfillmentArgs
    desc Structure is documented below.
    Location string
    (Optional)
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    TextToSpeechSettings EnvironmentTextToSpeechSettingsArgs
    Text to speech settings for this environment. Structure is documented below.
    environmentid String
    (Required)
    agentVersion String
    The agent version loaded into this environment. Supported formats:

    • projects//agent/versions/
    • projects//locations//agent/versions/
    description String
    The developer-provided description for this environment.
    fulfillment EnvironmentFulfillment
    desc Structure is documented below.
    location String
    (Optional)
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    textToSpeechSettings EnvironmentTextToSpeechSettings
    Text to speech settings for this environment. Structure is documented below.
    environmentid string
    (Required)
    agentVersion string
    The agent version loaded into this environment. Supported formats:

    • projects//agent/versions/
    • projects//locations//agent/versions/
    description string
    The developer-provided description for this environment.
    fulfillment EnvironmentFulfillment
    desc Structure is documented below.
    location string
    (Optional)
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    textToSpeechSettings EnvironmentTextToSpeechSettings
    Text to speech settings for this environment. Structure is documented below.
    environmentid str
    (Required)
    agent_version str
    The agent version loaded into this environment. Supported formats:

    • projects//agent/versions/
    • projects//locations//agent/versions/
    description str
    The developer-provided description for this environment.
    fulfillment EnvironmentFulfillmentArgs
    desc Structure is documented below.
    location str
    (Optional)
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    text_to_speech_settings EnvironmentTextToSpeechSettingsArgs
    Text to speech settings for this environment. Structure is documented below.
    environmentid String
    (Required)
    agentVersion String
    The agent version loaded into this environment. Supported formats:

    • projects//agent/versions/
    • projects//locations//agent/versions/
    description String
    The developer-provided description for this environment.
    fulfillment Property Map
    desc Structure is documented below.
    location String
    (Optional)
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    textToSpeechSettings Property Map
    Text to speech settings for this environment. Structure is documented below.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The unique identifier of this agent environment.
    State string
    The state of this environment.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The unique identifier of this agent environment.
    State string
    The state of this environment.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The unique identifier of this agent environment.
    state String
    The state of this environment.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The unique identifier of this agent environment.
    state string
    The state of this environment.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The unique identifier of this agent environment.
    state str
    The state of this environment.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The unique identifier of this agent environment.
    state String
    The state of this environment.

    Look up Existing Environment Resource

    Get an existing Environment 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?: EnvironmentState, opts?: CustomResourceOptions): Environment
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            agent_version: Optional[str] = None,
            description: Optional[str] = None,
            environmentid: Optional[str] = None,
            fulfillment: Optional[EnvironmentFulfillmentArgs] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            state: Optional[str] = None,
            text_to_speech_settings: Optional[EnvironmentTextToSpeechSettingsArgs] = None) -> Environment
    func GetEnvironment(ctx *Context, name string, id IDInput, state *EnvironmentState, opts ...ResourceOption) (*Environment, error)
    public static Environment Get(string name, Input<string> id, EnvironmentState? state, CustomResourceOptions? opts = null)
    public static Environment get(String name, Output<String> id, EnvironmentState state, CustomResourceOptions options)
    resources:  _:    type: gcp:diagflow:Environment    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:
    AgentVersion string
    The agent version loaded into this environment. Supported formats:

    • projects//agent/versions/
    • projects//locations//agent/versions/
    Description string
    The developer-provided description for this environment.
    Environmentid string
    (Required)
    Fulfillment EnvironmentFulfillment
    desc Structure is documented below.
    Location string
    (Optional)
    Name string
    The unique identifier of this agent environment.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    State string
    The state of this environment.
    TextToSpeechSettings EnvironmentTextToSpeechSettings
    Text to speech settings for this environment. Structure is documented below.
    AgentVersion string
    The agent version loaded into this environment. Supported formats:

    • projects//agent/versions/
    • projects//locations//agent/versions/
    Description string
    The developer-provided description for this environment.
    Environmentid string
    (Required)
    Fulfillment EnvironmentFulfillmentArgs
    desc Structure is documented below.
    Location string
    (Optional)
    Name string
    The unique identifier of this agent environment.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    State string
    The state of this environment.
    TextToSpeechSettings EnvironmentTextToSpeechSettingsArgs
    Text to speech settings for this environment. Structure is documented below.
    agentVersion String
    The agent version loaded into this environment. Supported formats:

    • projects//agent/versions/
    • projects//locations//agent/versions/
    description String
    The developer-provided description for this environment.
    environmentid String
    (Required)
    fulfillment EnvironmentFulfillment
    desc Structure is documented below.
    location String
    (Optional)
    name String
    The unique identifier of this agent environment.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    state String
    The state of this environment.
    textToSpeechSettings EnvironmentTextToSpeechSettings
    Text to speech settings for this environment. Structure is documented below.
    agentVersion string
    The agent version loaded into this environment. Supported formats:

    • projects//agent/versions/
    • projects//locations//agent/versions/
    description string
    The developer-provided description for this environment.
    environmentid string
    (Required)
    fulfillment EnvironmentFulfillment
    desc Structure is documented below.
    location string
    (Optional)
    name string
    The unique identifier of this agent environment.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    state string
    The state of this environment.
    textToSpeechSettings EnvironmentTextToSpeechSettings
    Text to speech settings for this environment. Structure is documented below.
    agent_version str
    The agent version loaded into this environment. Supported formats:

    • projects//agent/versions/
    • projects//locations//agent/versions/
    description str
    The developer-provided description for this environment.
    environmentid str
    (Required)
    fulfillment EnvironmentFulfillmentArgs
    desc Structure is documented below.
    location str
    (Optional)
    name str
    The unique identifier of this agent environment.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    state str
    The state of this environment.
    text_to_speech_settings EnvironmentTextToSpeechSettingsArgs
    Text to speech settings for this environment. Structure is documented below.
    agentVersion String
    The agent version loaded into this environment. Supported formats:

    • projects//agent/versions/
    • projects//locations//agent/versions/
    description String
    The developer-provided description for this environment.
    environmentid String
    (Required)
    fulfillment Property Map
    desc Structure is documented below.
    location String
    (Optional)
    name String
    The unique identifier of this agent environment.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    state String
    The state of this environment.
    textToSpeechSettings Property Map
    Text to speech settings for this environment. Structure is documented below.

    Supporting Types

    EnvironmentFulfillment, EnvironmentFulfillmentArgs

    DisplayName string
    The human-readable name of the fulfillment, unique within the agent.
    Features List<EnvironmentFulfillmentFeature>
    The field defines whether the fulfillment is enabled for certain features. Structure is documented below.
    GenericWebService EnvironmentFulfillmentGenericWebService
    Represents configuration for a generic web service. Structure is documented below.
    Name string
    The unique identifier of the fulfillment. Supports the following formats:

    • projects//agent/fulfillment
    • projects//locations//agent/fulfillment
    DisplayName string
    The human-readable name of the fulfillment, unique within the agent.
    Features []EnvironmentFulfillmentFeature
    The field defines whether the fulfillment is enabled for certain features. Structure is documented below.
    GenericWebService EnvironmentFulfillmentGenericWebService
    Represents configuration for a generic web service. Structure is documented below.
    Name string
    The unique identifier of the fulfillment. Supports the following formats:

    • projects//agent/fulfillment
    • projects//locations//agent/fulfillment
    displayName String
    The human-readable name of the fulfillment, unique within the agent.
    features List<EnvironmentFulfillmentFeature>
    The field defines whether the fulfillment is enabled for certain features. Structure is documented below.
    genericWebService EnvironmentFulfillmentGenericWebService
    Represents configuration for a generic web service. Structure is documented below.
    name String
    The unique identifier of the fulfillment. Supports the following formats:

    • projects//agent/fulfillment
    • projects//locations//agent/fulfillment
    displayName string
    The human-readable name of the fulfillment, unique within the agent.
    features EnvironmentFulfillmentFeature[]
    The field defines whether the fulfillment is enabled for certain features. Structure is documented below.
    genericWebService EnvironmentFulfillmentGenericWebService
    Represents configuration for a generic web service. Structure is documented below.
    name string
    The unique identifier of the fulfillment. Supports the following formats:

    • projects//agent/fulfillment
    • projects//locations//agent/fulfillment
    display_name str
    The human-readable name of the fulfillment, unique within the agent.
    features Sequence[EnvironmentFulfillmentFeature]
    The field defines whether the fulfillment is enabled for certain features. Structure is documented below.
    generic_web_service EnvironmentFulfillmentGenericWebService
    Represents configuration for a generic web service. Structure is documented below.
    name str
    The unique identifier of the fulfillment. Supports the following formats:

    • projects//agent/fulfillment
    • projects//locations//agent/fulfillment
    displayName String
    The human-readable name of the fulfillment, unique within the agent.
    features List<Property Map>
    The field defines whether the fulfillment is enabled for certain features. Structure is documented below.
    genericWebService Property Map
    Represents configuration for a generic web service. Structure is documented below.
    name String
    The unique identifier of the fulfillment. Supports the following formats:

    • projects//agent/fulfillment
    • projects//locations//agent/fulfillment

    EnvironmentFulfillmentFeature, EnvironmentFulfillmentFeatureArgs

    Type string
    The type of the feature that enabled for fulfillment. Possible values are: TYPE_UNSPECIFIED, SMALLTALK.
    Type string
    The type of the feature that enabled for fulfillment. Possible values are: TYPE_UNSPECIFIED, SMALLTALK.
    type String
    The type of the feature that enabled for fulfillment. Possible values are: TYPE_UNSPECIFIED, SMALLTALK.
    type string
    The type of the feature that enabled for fulfillment. Possible values are: TYPE_UNSPECIFIED, SMALLTALK.
    type str
    The type of the feature that enabled for fulfillment. Possible values are: TYPE_UNSPECIFIED, SMALLTALK.
    type String
    The type of the feature that enabled for fulfillment. Possible values are: TYPE_UNSPECIFIED, SMALLTALK.

    EnvironmentFulfillmentGenericWebService, EnvironmentFulfillmentGenericWebServiceArgs

    Uri string
    The fulfillment URI for receiving POST requests. It must use https protocol.
    Password string
    The password for HTTP Basic authentication.
    RequestHeaders Dictionary<string, string>
    The HTTP request headers to send together with fulfillment requests
    Username string
    The user name for HTTP Basic authentication.
    Uri string
    The fulfillment URI for receiving POST requests. It must use https protocol.
    Password string
    The password for HTTP Basic authentication.
    RequestHeaders map[string]string
    The HTTP request headers to send together with fulfillment requests
    Username string
    The user name for HTTP Basic authentication.
    uri String
    The fulfillment URI for receiving POST requests. It must use https protocol.
    password String
    The password for HTTP Basic authentication.
    requestHeaders Map<String,String>
    The HTTP request headers to send together with fulfillment requests
    username String
    The user name for HTTP Basic authentication.
    uri string
    The fulfillment URI for receiving POST requests. It must use https protocol.
    password string
    The password for HTTP Basic authentication.
    requestHeaders {[key: string]: string}
    The HTTP request headers to send together with fulfillment requests
    username string
    The user name for HTTP Basic authentication.
    uri str
    The fulfillment URI for receiving POST requests. It must use https protocol.
    password str
    The password for HTTP Basic authentication.
    request_headers Mapping[str, str]
    The HTTP request headers to send together with fulfillment requests
    username str
    The user name for HTTP Basic authentication.
    uri String
    The fulfillment URI for receiving POST requests. It must use https protocol.
    password String
    The password for HTTP Basic authentication.
    requestHeaders Map<String>
    The HTTP request headers to send together with fulfillment requests
    username String
    The user name for HTTP Basic authentication.

    EnvironmentTextToSpeechSettings, EnvironmentTextToSpeechSettingsArgs

    EnableTextToSpeech bool
    Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
    OutputAudioEncoding string
    Audio encoding of the synthesized audio content. Possible values are: OUTPUT_AUDIO_ENCODING_UNSPECIFIED, OUTPUT_AUDIO_ENCODING_LINEAR_16, OUTPUT_AUDIO_ENCODING_MP3, OUTPUT_AUDIO_ENCODING_MP3_64_KBPS, OUTPUT_AUDIO_ENCODING_OGG_OPUS, OUTPUT_AUDIO_ENCODING_MULAW, OUTPUT_AUDIO_ENCODING_ALAW.
    SampleRateHertz int
    The synthesis sample rate (in hertz) for this audio.
    SynthesizeSpeechConfigs List<EnvironmentTextToSpeechSettingsSynthesizeSpeechConfig>
    Configuration of how speech should be synthesized, mapping from language to SynthesizeSpeechConfig. Structure is documented below.
    EnableTextToSpeech bool
    Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
    OutputAudioEncoding string
    Audio encoding of the synthesized audio content. Possible values are: OUTPUT_AUDIO_ENCODING_UNSPECIFIED, OUTPUT_AUDIO_ENCODING_LINEAR_16, OUTPUT_AUDIO_ENCODING_MP3, OUTPUT_AUDIO_ENCODING_MP3_64_KBPS, OUTPUT_AUDIO_ENCODING_OGG_OPUS, OUTPUT_AUDIO_ENCODING_MULAW, OUTPUT_AUDIO_ENCODING_ALAW.
    SampleRateHertz int
    The synthesis sample rate (in hertz) for this audio.
    SynthesizeSpeechConfigs []EnvironmentTextToSpeechSettingsSynthesizeSpeechConfig
    Configuration of how speech should be synthesized, mapping from language to SynthesizeSpeechConfig. Structure is documented below.
    enableTextToSpeech Boolean
    Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
    outputAudioEncoding String
    Audio encoding of the synthesized audio content. Possible values are: OUTPUT_AUDIO_ENCODING_UNSPECIFIED, OUTPUT_AUDIO_ENCODING_LINEAR_16, OUTPUT_AUDIO_ENCODING_MP3, OUTPUT_AUDIO_ENCODING_MP3_64_KBPS, OUTPUT_AUDIO_ENCODING_OGG_OPUS, OUTPUT_AUDIO_ENCODING_MULAW, OUTPUT_AUDIO_ENCODING_ALAW.
    sampleRateHertz Integer
    The synthesis sample rate (in hertz) for this audio.
    synthesizeSpeechConfigs List<EnvironmentTextToSpeechSettingsSynthesizeSpeechConfig>
    Configuration of how speech should be synthesized, mapping from language to SynthesizeSpeechConfig. Structure is documented below.
    enableTextToSpeech boolean
    Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
    outputAudioEncoding string
    Audio encoding of the synthesized audio content. Possible values are: OUTPUT_AUDIO_ENCODING_UNSPECIFIED, OUTPUT_AUDIO_ENCODING_LINEAR_16, OUTPUT_AUDIO_ENCODING_MP3, OUTPUT_AUDIO_ENCODING_MP3_64_KBPS, OUTPUT_AUDIO_ENCODING_OGG_OPUS, OUTPUT_AUDIO_ENCODING_MULAW, OUTPUT_AUDIO_ENCODING_ALAW.
    sampleRateHertz number
    The synthesis sample rate (in hertz) for this audio.
    synthesizeSpeechConfigs EnvironmentTextToSpeechSettingsSynthesizeSpeechConfig[]
    Configuration of how speech should be synthesized, mapping from language to SynthesizeSpeechConfig. Structure is documented below.
    enable_text_to_speech bool
    Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
    output_audio_encoding str
    Audio encoding of the synthesized audio content. Possible values are: OUTPUT_AUDIO_ENCODING_UNSPECIFIED, OUTPUT_AUDIO_ENCODING_LINEAR_16, OUTPUT_AUDIO_ENCODING_MP3, OUTPUT_AUDIO_ENCODING_MP3_64_KBPS, OUTPUT_AUDIO_ENCODING_OGG_OPUS, OUTPUT_AUDIO_ENCODING_MULAW, OUTPUT_AUDIO_ENCODING_ALAW.
    sample_rate_hertz int
    The synthesis sample rate (in hertz) for this audio.
    synthesize_speech_configs Sequence[EnvironmentTextToSpeechSettingsSynthesizeSpeechConfig]
    Configuration of how speech should be synthesized, mapping from language to SynthesizeSpeechConfig. Structure is documented below.
    enableTextToSpeech Boolean
    Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.
    outputAudioEncoding String
    Audio encoding of the synthesized audio content. Possible values are: OUTPUT_AUDIO_ENCODING_UNSPECIFIED, OUTPUT_AUDIO_ENCODING_LINEAR_16, OUTPUT_AUDIO_ENCODING_MP3, OUTPUT_AUDIO_ENCODING_MP3_64_KBPS, OUTPUT_AUDIO_ENCODING_OGG_OPUS, OUTPUT_AUDIO_ENCODING_MULAW, OUTPUT_AUDIO_ENCODING_ALAW.
    sampleRateHertz Number
    The synthesis sample rate (in hertz) for this audio.
    synthesizeSpeechConfigs List<Property Map>
    Configuration of how speech should be synthesized, mapping from language to SynthesizeSpeechConfig. Structure is documented below.

    EnvironmentTextToSpeechSettingsSynthesizeSpeechConfig, EnvironmentTextToSpeechSettingsSynthesizeSpeechConfigArgs

    Language string
    The identifier for this object. Format specified above.
    EffectsProfileIds List<string>
    An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
    Pitch double
    Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
    SpeakingRate double
    Speaking rate/speed, in the range [0.25, 4.0].
    Voice EnvironmentTextToSpeechSettingsSynthesizeSpeechConfigVoice
    The desired voice of the synthesized audio. Structure is documented below.
    VolumeGainDb double
    Volume gain (in dB) of the normal native volume supported by the specific voice.
    Language string
    The identifier for this object. Format specified above.
    EffectsProfileIds []string
    An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
    Pitch float64
    Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
    SpeakingRate float64
    Speaking rate/speed, in the range [0.25, 4.0].
    Voice EnvironmentTextToSpeechSettingsSynthesizeSpeechConfigVoice
    The desired voice of the synthesized audio. Structure is documented below.
    VolumeGainDb float64
    Volume gain (in dB) of the normal native volume supported by the specific voice.
    language String
    The identifier for this object. Format specified above.
    effectsProfileIds List<String>
    An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
    pitch Double
    Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
    speakingRate Double
    Speaking rate/speed, in the range [0.25, 4.0].
    voice EnvironmentTextToSpeechSettingsSynthesizeSpeechConfigVoice
    The desired voice of the synthesized audio. Structure is documented below.
    volumeGainDb Double
    Volume gain (in dB) of the normal native volume supported by the specific voice.
    language string
    The identifier for this object. Format specified above.
    effectsProfileIds string[]
    An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
    pitch number
    Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
    speakingRate number
    Speaking rate/speed, in the range [0.25, 4.0].
    voice EnvironmentTextToSpeechSettingsSynthesizeSpeechConfigVoice
    The desired voice of the synthesized audio. Structure is documented below.
    volumeGainDb number
    Volume gain (in dB) of the normal native volume supported by the specific voice.
    language str
    The identifier for this object. Format specified above.
    effects_profile_ids Sequence[str]
    An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
    pitch float
    Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
    speaking_rate float
    Speaking rate/speed, in the range [0.25, 4.0].
    voice EnvironmentTextToSpeechSettingsSynthesizeSpeechConfigVoice
    The desired voice of the synthesized audio. Structure is documented below.
    volume_gain_db float
    Volume gain (in dB) of the normal native volume supported by the specific voice.
    language String
    The identifier for this object. Format specified above.
    effectsProfileIds List<String>
    An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.
    pitch Number
    Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
    speakingRate Number
    Speaking rate/speed, in the range [0.25, 4.0].
    voice Property Map
    The desired voice of the synthesized audio. Structure is documented below.
    volumeGainDb Number
    Volume gain (in dB) of the normal native volume supported by the specific voice.

    EnvironmentTextToSpeechSettingsSynthesizeSpeechConfigVoice, EnvironmentTextToSpeechSettingsSynthesizeSpeechConfigVoiceArgs

    Name string
    The name of the voice.
    SsmlGender string
    The preferred gender of the voice. Possible values are: SSML_VOICE_GENDER_UNSPECIFIED, SSML_VOICE_GENDER_MALE, SSML_VOICE_GENDER_FEMALE, SSML_VOICE_GENDER_NEUTRAL.
    Name string
    The name of the voice.
    SsmlGender string
    The preferred gender of the voice. Possible values are: SSML_VOICE_GENDER_UNSPECIFIED, SSML_VOICE_GENDER_MALE, SSML_VOICE_GENDER_FEMALE, SSML_VOICE_GENDER_NEUTRAL.
    name String
    The name of the voice.
    ssmlGender String
    The preferred gender of the voice. Possible values are: SSML_VOICE_GENDER_UNSPECIFIED, SSML_VOICE_GENDER_MALE, SSML_VOICE_GENDER_FEMALE, SSML_VOICE_GENDER_NEUTRAL.
    name string
    The name of the voice.
    ssmlGender string
    The preferred gender of the voice. Possible values are: SSML_VOICE_GENDER_UNSPECIFIED, SSML_VOICE_GENDER_MALE, SSML_VOICE_GENDER_FEMALE, SSML_VOICE_GENDER_NEUTRAL.
    name str
    The name of the voice.
    ssml_gender str
    The preferred gender of the voice. Possible values are: SSML_VOICE_GENDER_UNSPECIFIED, SSML_VOICE_GENDER_MALE, SSML_VOICE_GENDER_FEMALE, SSML_VOICE_GENDER_NEUTRAL.
    name String
    The name of the voice.
    ssmlGender String
    The preferred gender of the voice. Possible values are: SSML_VOICE_GENDER_UNSPECIFIED, SSML_VOICE_GENDER_MALE, SSML_VOICE_GENDER_FEMALE, SSML_VOICE_GENDER_NEUTRAL.

    Import

    Environment can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/agent/environments/{{environmentid}}
    • {{project}}/{{location}}/{{environmentid}}
    • {{location}}/{{environmentid}}

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

    $ pulumi import gcp:diagflow/environment:Environment default projects/{{project}}/locations/{{location}}/agent/environments/{{environmentid}}
    $ pulumi import gcp:diagflow/environment:Environment default {{project}}/{{location}}/{{environmentid}}
    $ pulumi import gcp:diagflow/environment:Environment default {{location}}/{{environmentid}}
    

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

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Viewing docs for Google Cloud v9.17.0
    published on Tuesday, Mar 31, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.