1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ServiceMesh
  5. VirtualDeployment
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.ServiceMesh.VirtualDeployment

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

    This resource provides the Virtual Deployment resource in Oracle Cloud Infrastructure Service Mesh service.

    Creates a new VirtualDeployment.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testVirtualDeployment = new oci.servicemesh.VirtualDeployment("test_virtual_deployment", {
        compartmentId: compartmentId,
        name: virtualDeploymentName,
        virtualServiceId: testVirtualService.id,
        accessLogging: {
            isEnabled: virtualDeploymentAccessLoggingIsEnabled,
        },
        definedTags: {
            "foo-namespace.bar-key": "value",
        },
        description: virtualDeploymentDescription,
        freeformTags: {
            "bar-key": "value",
        },
        listeners: [{
            port: virtualDeploymentListenersPort,
            protocol: virtualDeploymentListenersProtocol,
            idleTimeoutInMs: virtualDeploymentListenersIdleTimeoutInMs,
            requestTimeoutInMs: virtualDeploymentListenersRequestTimeoutInMs,
        }],
        serviceDiscovery: {
            type: virtualDeploymentServiceDiscoveryType,
            hostname: virtualDeploymentServiceDiscoveryHostname,
        },
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_virtual_deployment = oci.service_mesh.VirtualDeployment("test_virtual_deployment",
        compartment_id=compartment_id,
        name=virtual_deployment_name,
        virtual_service_id=test_virtual_service["id"],
        access_logging={
            "is_enabled": virtual_deployment_access_logging_is_enabled,
        },
        defined_tags={
            "foo-namespace.bar-key": "value",
        },
        description=virtual_deployment_description,
        freeform_tags={
            "bar-key": "value",
        },
        listeners=[{
            "port": virtual_deployment_listeners_port,
            "protocol": virtual_deployment_listeners_protocol,
            "idle_timeout_in_ms": virtual_deployment_listeners_idle_timeout_in_ms,
            "request_timeout_in_ms": virtual_deployment_listeners_request_timeout_in_ms,
        }],
        service_discovery={
            "type": virtual_deployment_service_discovery_type,
            "hostname": virtual_deployment_service_discovery_hostname,
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/ServiceMesh"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ServiceMesh.NewVirtualDeployment(ctx, "test_virtual_deployment", &ServiceMesh.VirtualDeploymentArgs{
    			CompartmentId:    pulumi.Any(compartmentId),
    			Name:             pulumi.Any(virtualDeploymentName),
    			VirtualServiceId: pulumi.Any(testVirtualService.Id),
    			AccessLogging: &servicemesh.VirtualDeploymentAccessLoggingArgs{
    				IsEnabled: pulumi.Any(virtualDeploymentAccessLoggingIsEnabled),
    			},
    			DefinedTags: pulumi.StringMap{
    				"foo-namespace.bar-key": pulumi.String("value"),
    			},
    			Description: pulumi.Any(virtualDeploymentDescription),
    			FreeformTags: pulumi.StringMap{
    				"bar-key": pulumi.String("value"),
    			},
    			Listeners: servicemesh.VirtualDeploymentListenerArray{
    				&servicemesh.VirtualDeploymentListenerArgs{
    					Port:               pulumi.Any(virtualDeploymentListenersPort),
    					Protocol:           pulumi.Any(virtualDeploymentListenersProtocol),
    					IdleTimeoutInMs:    pulumi.Any(virtualDeploymentListenersIdleTimeoutInMs),
    					RequestTimeoutInMs: pulumi.Any(virtualDeploymentListenersRequestTimeoutInMs),
    				},
    			},
    			ServiceDiscovery: &servicemesh.VirtualDeploymentServiceDiscoveryArgs{
    				Type:     pulumi.Any(virtualDeploymentServiceDiscoveryType),
    				Hostname: pulumi.Any(virtualDeploymentServiceDiscoveryHostname),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testVirtualDeployment = new Oci.ServiceMesh.VirtualDeployment("test_virtual_deployment", new()
        {
            CompartmentId = compartmentId,
            Name = virtualDeploymentName,
            VirtualServiceId = testVirtualService.Id,
            AccessLogging = new Oci.ServiceMesh.Inputs.VirtualDeploymentAccessLoggingArgs
            {
                IsEnabled = virtualDeploymentAccessLoggingIsEnabled,
            },
            DefinedTags = 
            {
                { "foo-namespace.bar-key", "value" },
            },
            Description = virtualDeploymentDescription,
            FreeformTags = 
            {
                { "bar-key", "value" },
            },
            Listeners = new[]
            {
                new Oci.ServiceMesh.Inputs.VirtualDeploymentListenerArgs
                {
                    Port = virtualDeploymentListenersPort,
                    Protocol = virtualDeploymentListenersProtocol,
                    IdleTimeoutInMs = virtualDeploymentListenersIdleTimeoutInMs,
                    RequestTimeoutInMs = virtualDeploymentListenersRequestTimeoutInMs,
                },
            },
            ServiceDiscovery = new Oci.ServiceMesh.Inputs.VirtualDeploymentServiceDiscoveryArgs
            {
                Type = virtualDeploymentServiceDiscoveryType,
                Hostname = virtualDeploymentServiceDiscoveryHostname,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.ServiceMesh.VirtualDeployment;
    import com.pulumi.oci.ServiceMesh.VirtualDeploymentArgs;
    import com.pulumi.oci.ServiceMesh.inputs.VirtualDeploymentAccessLoggingArgs;
    import com.pulumi.oci.ServiceMesh.inputs.VirtualDeploymentListenerArgs;
    import com.pulumi.oci.ServiceMesh.inputs.VirtualDeploymentServiceDiscoveryArgs;
    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 testVirtualDeployment = new VirtualDeployment("testVirtualDeployment", VirtualDeploymentArgs.builder()
                .compartmentId(compartmentId)
                .name(virtualDeploymentName)
                .virtualServiceId(testVirtualService.id())
                .accessLogging(VirtualDeploymentAccessLoggingArgs.builder()
                    .isEnabled(virtualDeploymentAccessLoggingIsEnabled)
                    .build())
                .definedTags(Map.of("foo-namespace.bar-key", "value"))
                .description(virtualDeploymentDescription)
                .freeformTags(Map.of("bar-key", "value"))
                .listeners(VirtualDeploymentListenerArgs.builder()
                    .port(virtualDeploymentListenersPort)
                    .protocol(virtualDeploymentListenersProtocol)
                    .idleTimeoutInMs(virtualDeploymentListenersIdleTimeoutInMs)
                    .requestTimeoutInMs(virtualDeploymentListenersRequestTimeoutInMs)
                    .build())
                .serviceDiscovery(VirtualDeploymentServiceDiscoveryArgs.builder()
                    .type(virtualDeploymentServiceDiscoveryType)
                    .hostname(virtualDeploymentServiceDiscoveryHostname)
                    .build())
                .build());
    
        }
    }
    
    resources:
      testVirtualDeployment:
        type: oci:ServiceMesh:VirtualDeployment
        name: test_virtual_deployment
        properties:
          compartmentId: ${compartmentId}
          name: ${virtualDeploymentName}
          virtualServiceId: ${testVirtualService.id}
          accessLogging:
            isEnabled: ${virtualDeploymentAccessLoggingIsEnabled}
          definedTags:
            foo-namespace.bar-key: value
          description: ${virtualDeploymentDescription}
          freeformTags:
            bar-key: value
          listeners:
            - port: ${virtualDeploymentListenersPort}
              protocol: ${virtualDeploymentListenersProtocol}
              idleTimeoutInMs: ${virtualDeploymentListenersIdleTimeoutInMs}
              requestTimeoutInMs: ${virtualDeploymentListenersRequestTimeoutInMs}
          serviceDiscovery:
            type: ${virtualDeploymentServiceDiscoveryType}
            hostname: ${virtualDeploymentServiceDiscoveryHostname}
    

    Create VirtualDeployment Resource

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

    Constructor syntax

    new VirtualDeployment(name: string, args: VirtualDeploymentArgs, opts?: CustomResourceOptions);
    @overload
    def VirtualDeployment(resource_name: str,
                          args: VirtualDeploymentArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def VirtualDeployment(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          compartment_id: Optional[str] = None,
                          virtual_service_id: Optional[str] = None,
                          access_logging: Optional[_servicemesh.VirtualDeploymentAccessLoggingArgs] = None,
                          defined_tags: Optional[Mapping[str, str]] = None,
                          description: Optional[str] = None,
                          freeform_tags: Optional[Mapping[str, str]] = None,
                          listeners: Optional[Sequence[_servicemesh.VirtualDeploymentListenerArgs]] = None,
                          name: Optional[str] = None,
                          service_discovery: Optional[_servicemesh.VirtualDeploymentServiceDiscoveryArgs] = None)
    func NewVirtualDeployment(ctx *Context, name string, args VirtualDeploymentArgs, opts ...ResourceOption) (*VirtualDeployment, error)
    public VirtualDeployment(string name, VirtualDeploymentArgs args, CustomResourceOptions? opts = null)
    public VirtualDeployment(String name, VirtualDeploymentArgs args)
    public VirtualDeployment(String name, VirtualDeploymentArgs args, CustomResourceOptions options)
    
    type: oci:ServiceMesh:VirtualDeployment
    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 VirtualDeploymentArgs
    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 VirtualDeploymentArgs
    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 VirtualDeploymentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VirtualDeploymentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VirtualDeploymentArgs
    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 virtualDeploymentResource = new Oci.ServiceMesh.VirtualDeployment("virtualDeploymentResource", new()
    {
        CompartmentId = "string",
        VirtualServiceId = "string",
        AccessLogging = new Oci.ServiceMesh.Inputs.VirtualDeploymentAccessLoggingArgs
        {
            IsEnabled = false,
        },
        DefinedTags = 
        {
            { "string", "string" },
        },
        Description = "string",
        FreeformTags = 
        {
            { "string", "string" },
        },
        Listeners = new[]
        {
            new Oci.ServiceMesh.Inputs.VirtualDeploymentListenerArgs
            {
                Port = 0,
                Protocol = "string",
                IdleTimeoutInMs = "string",
                RequestTimeoutInMs = "string",
            },
        },
        Name = "string",
        ServiceDiscovery = new Oci.ServiceMesh.Inputs.VirtualDeploymentServiceDiscoveryArgs
        {
            Type = "string",
            Hostname = "string",
        },
    });
    
    example, err := ServiceMesh.NewVirtualDeployment(ctx, "virtualDeploymentResource", &ServiceMesh.VirtualDeploymentArgs{
    	CompartmentId:    pulumi.String("string"),
    	VirtualServiceId: pulumi.String("string"),
    	AccessLogging: &servicemesh.VirtualDeploymentAccessLoggingArgs{
    		IsEnabled: pulumi.Bool(false),
    	},
    	DefinedTags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Description: pulumi.String("string"),
    	FreeformTags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Listeners: servicemesh.VirtualDeploymentListenerArray{
    		&servicemesh.VirtualDeploymentListenerArgs{
    			Port:               pulumi.Int(0),
    			Protocol:           pulumi.String("string"),
    			IdleTimeoutInMs:    pulumi.String("string"),
    			RequestTimeoutInMs: pulumi.String("string"),
    		},
    	},
    	Name: pulumi.String("string"),
    	ServiceDiscovery: &servicemesh.VirtualDeploymentServiceDiscoveryArgs{
    		Type:     pulumi.String("string"),
    		Hostname: pulumi.String("string"),
    	},
    })
    
    var virtualDeploymentResource = new VirtualDeployment("virtualDeploymentResource", VirtualDeploymentArgs.builder()
        .compartmentId("string")
        .virtualServiceId("string")
        .accessLogging(VirtualDeploymentAccessLoggingArgs.builder()
            .isEnabled(false)
            .build())
        .definedTags(Map.of("string", "string"))
        .description("string")
        .freeformTags(Map.of("string", "string"))
        .listeners(VirtualDeploymentListenerArgs.builder()
            .port(0)
            .protocol("string")
            .idleTimeoutInMs("string")
            .requestTimeoutInMs("string")
            .build())
        .name("string")
        .serviceDiscovery(VirtualDeploymentServiceDiscoveryArgs.builder()
            .type("string")
            .hostname("string")
            .build())
        .build());
    
    virtual_deployment_resource = oci.service_mesh.VirtualDeployment("virtualDeploymentResource",
        compartment_id="string",
        virtual_service_id="string",
        access_logging={
            "is_enabled": False,
        },
        defined_tags={
            "string": "string",
        },
        description="string",
        freeform_tags={
            "string": "string",
        },
        listeners=[{
            "port": 0,
            "protocol": "string",
            "idle_timeout_in_ms": "string",
            "request_timeout_in_ms": "string",
        }],
        name="string",
        service_discovery={
            "type": "string",
            "hostname": "string",
        })
    
    const virtualDeploymentResource = new oci.servicemesh.VirtualDeployment("virtualDeploymentResource", {
        compartmentId: "string",
        virtualServiceId: "string",
        accessLogging: {
            isEnabled: false,
        },
        definedTags: {
            string: "string",
        },
        description: "string",
        freeformTags: {
            string: "string",
        },
        listeners: [{
            port: 0,
            protocol: "string",
            idleTimeoutInMs: "string",
            requestTimeoutInMs: "string",
        }],
        name: "string",
        serviceDiscovery: {
            type: "string",
            hostname: "string",
        },
    });
    
    type: oci:ServiceMesh:VirtualDeployment
    properties:
        accessLogging:
            isEnabled: false
        compartmentId: string
        definedTags:
            string: string
        description: string
        freeformTags:
            string: string
        listeners:
            - idleTimeoutInMs: string
              port: 0
              protocol: string
              requestTimeoutInMs: string
        name: string
        serviceDiscovery:
            hostname: string
            type: string
        virtualServiceId: string
    

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

    CompartmentId string
    (Updatable) The OCID of the compartment.
    VirtualServiceId string

    The OCID of the service mesh in which this access policy is created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    AccessLogging VirtualDeploymentAccessLogging
    (Updatable) This configuration determines if logging is enabled and where the logs will be output.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) Description of the resource. It can be changed after creation. Avoid entering confidential information. Example: This is my new resource
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Listeners List<VirtualDeploymentListener>
    (Updatable) The listeners for the virtual deployment.
    Name string
    A user-friendly name. The name must be unique within the same virtual service and cannot be changed after creation. Avoid entering confidential information. Example: My unique resource name
    ServiceDiscovery VirtualDeploymentServiceDiscovery
    (Updatable) Service Discovery configuration for virtual deployments.
    CompartmentId string
    (Updatable) The OCID of the compartment.
    VirtualServiceId string

    The OCID of the service mesh in which this access policy is created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    AccessLogging VirtualDeploymentAccessLoggingArgs
    (Updatable) This configuration determines if logging is enabled and where the logs will be output.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) Description of the resource. It can be changed after creation. Avoid entering confidential information. Example: This is my new resource
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Listeners []VirtualDeploymentListenerArgs
    (Updatable) The listeners for the virtual deployment.
    Name string
    A user-friendly name. The name must be unique within the same virtual service and cannot be changed after creation. Avoid entering confidential information. Example: My unique resource name
    ServiceDiscovery VirtualDeploymentServiceDiscoveryArgs
    (Updatable) Service Discovery configuration for virtual deployments.
    compartmentId String
    (Updatable) The OCID of the compartment.
    virtualServiceId String

    The OCID of the service mesh in which this access policy is created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    accessLogging VirtualDeploymentAccessLogging
    (Updatable) This configuration determines if logging is enabled and where the logs will be output.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) Description of the resource. It can be changed after creation. Avoid entering confidential information. Example: This is my new resource
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    listeners List<VirtualDeploymentListener>
    (Updatable) The listeners for the virtual deployment.
    name String
    A user-friendly name. The name must be unique within the same virtual service and cannot be changed after creation. Avoid entering confidential information. Example: My unique resource name
    serviceDiscovery VirtualDeploymentServiceDiscovery
    (Updatable) Service Discovery configuration for virtual deployments.
    compartmentId string
    (Updatable) The OCID of the compartment.
    virtualServiceId string

    The OCID of the service mesh in which this access policy is created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    accessLogging VirtualDeploymentAccessLogging
    (Updatable) This configuration determines if logging is enabled and where the logs will be output.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    (Updatable) Description of the resource. It can be changed after creation. Avoid entering confidential information. Example: This is my new resource
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    listeners VirtualDeploymentListener[]
    (Updatable) The listeners for the virtual deployment.
    name string
    A user-friendly name. The name must be unique within the same virtual service and cannot be changed after creation. Avoid entering confidential information. Example: My unique resource name
    serviceDiscovery VirtualDeploymentServiceDiscovery
    (Updatable) Service Discovery configuration for virtual deployments.
    compartment_id str
    (Updatable) The OCID of the compartment.
    virtual_service_id str

    The OCID of the service mesh in which this access policy is created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    access_logging servicemesh.VirtualDeploymentAccessLoggingArgs
    (Updatable) This configuration determines if logging is enabled and where the logs will be output.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    (Updatable) Description of the resource. It can be changed after creation. Avoid entering confidential information. Example: This is my new resource
    freeform_tags Mapping[str, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    listeners Sequence[servicemesh.VirtualDeploymentListenerArgs]
    (Updatable) The listeners for the virtual deployment.
    name str
    A user-friendly name. The name must be unique within the same virtual service and cannot be changed after creation. Avoid entering confidential information. Example: My unique resource name
    service_discovery servicemesh.VirtualDeploymentServiceDiscoveryArgs
    (Updatable) Service Discovery configuration for virtual deployments.
    compartmentId String
    (Updatable) The OCID of the compartment.
    virtualServiceId String

    The OCID of the service mesh in which this access policy is created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    accessLogging Property Map
    (Updatable) This configuration determines if logging is enabled and where the logs will be output.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) Description of the resource. It can be changed after creation. Avoid entering confidential information. Example: This is my new resource
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    listeners List<Property Map>
    (Updatable) The listeners for the virtual deployment.
    name String
    A user-friendly name. The name must be unique within the same virtual service and cannot be changed after creation. Avoid entering confidential information. Example: My unique resource name
    serviceDiscovery Property Map
    (Updatable) Service Discovery configuration for virtual deployments.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    State string
    The current state of the Resource.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time when this resource was created in an RFC3339 formatted datetime string.
    TimeUpdated string
    The time when this resource was updated in an RFC3339 formatted datetime string.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    State string
    The current state of the Resource.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time when this resource was created in an RFC3339 formatted datetime string.
    TimeUpdated string
    The time when this resource was updated in an RFC3339 formatted datetime string.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    state String
    The current state of the Resource.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time when this resource was created in an RFC3339 formatted datetime string.
    timeUpdated String
    The time when this resource was updated in an RFC3339 formatted datetime string.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    state string
    The current state of the Resource.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time when this resource was created in an RFC3339 formatted datetime string.
    timeUpdated string
    The time when this resource was updated in an RFC3339 formatted datetime string.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    state str
    The current state of the Resource.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time when this resource was created in an RFC3339 formatted datetime string.
    time_updated str
    The time when this resource was updated in an RFC3339 formatted datetime string.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    state String
    The current state of the Resource.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time when this resource was created in an RFC3339 formatted datetime string.
    timeUpdated String
    The time when this resource was updated in an RFC3339 formatted datetime string.

    Look up Existing VirtualDeployment Resource

    Get an existing VirtualDeployment 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?: VirtualDeploymentState, opts?: CustomResourceOptions): VirtualDeployment
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_logging: Optional[_servicemesh.VirtualDeploymentAccessLoggingArgs] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, str]] = None,
            description: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, str]] = None,
            lifecycle_details: Optional[str] = None,
            listeners: Optional[Sequence[_servicemesh.VirtualDeploymentListenerArgs]] = None,
            name: Optional[str] = None,
            service_discovery: Optional[_servicemesh.VirtualDeploymentServiceDiscoveryArgs] = None,
            state: Optional[str] = None,
            system_tags: Optional[Mapping[str, str]] = None,
            time_created: Optional[str] = None,
            time_updated: Optional[str] = None,
            virtual_service_id: Optional[str] = None) -> VirtualDeployment
    func GetVirtualDeployment(ctx *Context, name string, id IDInput, state *VirtualDeploymentState, opts ...ResourceOption) (*VirtualDeployment, error)
    public static VirtualDeployment Get(string name, Input<string> id, VirtualDeploymentState? state, CustomResourceOptions? opts = null)
    public static VirtualDeployment get(String name, Output<String> id, VirtualDeploymentState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccessLogging VirtualDeploymentAccessLogging
    (Updatable) This configuration determines if logging is enabled and where the logs will be output.
    CompartmentId string
    (Updatable) The OCID of the compartment.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) Description of the resource. It can be changed after creation. Avoid entering confidential information. Example: This is my new resource
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    Listeners List<VirtualDeploymentListener>
    (Updatable) The listeners for the virtual deployment.
    Name string
    A user-friendly name. The name must be unique within the same virtual service and cannot be changed after creation. Avoid entering confidential information. Example: My unique resource name
    ServiceDiscovery VirtualDeploymentServiceDiscovery
    (Updatable) Service Discovery configuration for virtual deployments.
    State string
    The current state of the Resource.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time when this resource was created in an RFC3339 formatted datetime string.
    TimeUpdated string
    The time when this resource was updated in an RFC3339 formatted datetime string.
    VirtualServiceId string

    The OCID of the service mesh in which this access policy is created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    AccessLogging VirtualDeploymentAccessLoggingArgs
    (Updatable) This configuration determines if logging is enabled and where the logs will be output.
    CompartmentId string
    (Updatable) The OCID of the compartment.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) Description of the resource. It can be changed after creation. Avoid entering confidential information. Example: This is my new resource
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    Listeners []VirtualDeploymentListenerArgs
    (Updatable) The listeners for the virtual deployment.
    Name string
    A user-friendly name. The name must be unique within the same virtual service and cannot be changed after creation. Avoid entering confidential information. Example: My unique resource name
    ServiceDiscovery VirtualDeploymentServiceDiscoveryArgs
    (Updatable) Service Discovery configuration for virtual deployments.
    State string
    The current state of the Resource.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time when this resource was created in an RFC3339 formatted datetime string.
    TimeUpdated string
    The time when this resource was updated in an RFC3339 formatted datetime string.
    VirtualServiceId string

    The OCID of the service mesh in which this access policy is created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    accessLogging VirtualDeploymentAccessLogging
    (Updatable) This configuration determines if logging is enabled and where the logs will be output.
    compartmentId String
    (Updatable) The OCID of the compartment.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) Description of the resource. It can be changed after creation. Avoid entering confidential information. Example: This is my new resource
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    listeners List<VirtualDeploymentListener>
    (Updatable) The listeners for the virtual deployment.
    name String
    A user-friendly name. The name must be unique within the same virtual service and cannot be changed after creation. Avoid entering confidential information. Example: My unique resource name
    serviceDiscovery VirtualDeploymentServiceDiscovery
    (Updatable) Service Discovery configuration for virtual deployments.
    state String
    The current state of the Resource.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time when this resource was created in an RFC3339 formatted datetime string.
    timeUpdated String
    The time when this resource was updated in an RFC3339 formatted datetime string.
    virtualServiceId String

    The OCID of the service mesh in which this access policy is created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    accessLogging VirtualDeploymentAccessLogging
    (Updatable) This configuration determines if logging is enabled and where the logs will be output.
    compartmentId string
    (Updatable) The OCID of the compartment.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    (Updatable) Description of the resource. It can be changed after creation. Avoid entering confidential information. Example: This is my new resource
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    lifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    listeners VirtualDeploymentListener[]
    (Updatable) The listeners for the virtual deployment.
    name string
    A user-friendly name. The name must be unique within the same virtual service and cannot be changed after creation. Avoid entering confidential information. Example: My unique resource name
    serviceDiscovery VirtualDeploymentServiceDiscovery
    (Updatable) Service Discovery configuration for virtual deployments.
    state string
    The current state of the Resource.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time when this resource was created in an RFC3339 formatted datetime string.
    timeUpdated string
    The time when this resource was updated in an RFC3339 formatted datetime string.
    virtualServiceId string

    The OCID of the service mesh in which this access policy is created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    access_logging servicemesh.VirtualDeploymentAccessLoggingArgs
    (Updatable) This configuration determines if logging is enabled and where the logs will be output.
    compartment_id str
    (Updatable) The OCID of the compartment.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    (Updatable) Description of the resource. It can be changed after creation. Avoid entering confidential information. Example: This is my new resource
    freeform_tags Mapping[str, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    lifecycle_details str
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    listeners Sequence[servicemesh.VirtualDeploymentListenerArgs]
    (Updatable) The listeners for the virtual deployment.
    name str
    A user-friendly name. The name must be unique within the same virtual service and cannot be changed after creation. Avoid entering confidential information. Example: My unique resource name
    service_discovery servicemesh.VirtualDeploymentServiceDiscoveryArgs
    (Updatable) Service Discovery configuration for virtual deployments.
    state str
    The current state of the Resource.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time when this resource was created in an RFC3339 formatted datetime string.
    time_updated str
    The time when this resource was updated in an RFC3339 formatted datetime string.
    virtual_service_id str

    The OCID of the service mesh in which this access policy is created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    accessLogging Property Map
    (Updatable) This configuration determines if logging is enabled and where the logs will be output.
    compartmentId String
    (Updatable) The OCID of the compartment.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) Description of the resource. It can be changed after creation. Avoid entering confidential information. Example: This is my new resource
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    listeners List<Property Map>
    (Updatable) The listeners for the virtual deployment.
    name String
    A user-friendly name. The name must be unique within the same virtual service and cannot be changed after creation. Avoid entering confidential information. Example: My unique resource name
    serviceDiscovery Property Map
    (Updatable) Service Discovery configuration for virtual deployments.
    state String
    The current state of the Resource.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time when this resource was created in an RFC3339 formatted datetime string.
    timeUpdated String
    The time when this resource was updated in an RFC3339 formatted datetime string.
    virtualServiceId String

    The OCID of the service mesh in which this access policy is created.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Supporting Types

    VirtualDeploymentAccessLogging, VirtualDeploymentAccessLoggingArgs

    IsEnabled bool
    (Updatable) Determines if the logging configuration is enabled.
    IsEnabled bool
    (Updatable) Determines if the logging configuration is enabled.
    isEnabled Boolean
    (Updatable) Determines if the logging configuration is enabled.
    isEnabled boolean
    (Updatable) Determines if the logging configuration is enabled.
    is_enabled bool
    (Updatable) Determines if the logging configuration is enabled.
    isEnabled Boolean
    (Updatable) Determines if the logging configuration is enabled.

    VirtualDeploymentListener, VirtualDeploymentListenerArgs

    Port int
    (Updatable) Port in which virtual deployment is running.
    Protocol string
    (Updatable) Type of protocol used in virtual deployment.
    IdleTimeoutInMs string
    (Updatable) The maximum duration in milliseconds for which the request's stream may be idle. The value 0 (zero) indicates that the timeout is disabled.
    RequestTimeoutInMs string
    (Updatable) The maximum duration in milliseconds for the deployed service to respond to an incoming request through the listener. If provided, the timeout value overrides the default timeout of 15 seconds for the HTTP/HTTP2 listeners, and disabled (no timeout) for the GRPC listeners. The value 0 (zero) indicates that the timeout is disabled. The timeout cannot be configured for the TCP and TLS_PASSTHROUGH listeners. For streaming responses from the deployed service, consider either keeping the timeout disabled or set a sufficiently high value.
    Port int
    (Updatable) Port in which virtual deployment is running.
    Protocol string
    (Updatable) Type of protocol used in virtual deployment.
    IdleTimeoutInMs string
    (Updatable) The maximum duration in milliseconds for which the request's stream may be idle. The value 0 (zero) indicates that the timeout is disabled.
    RequestTimeoutInMs string
    (Updatable) The maximum duration in milliseconds for the deployed service to respond to an incoming request through the listener. If provided, the timeout value overrides the default timeout of 15 seconds for the HTTP/HTTP2 listeners, and disabled (no timeout) for the GRPC listeners. The value 0 (zero) indicates that the timeout is disabled. The timeout cannot be configured for the TCP and TLS_PASSTHROUGH listeners. For streaming responses from the deployed service, consider either keeping the timeout disabled or set a sufficiently high value.
    port Integer
    (Updatable) Port in which virtual deployment is running.
    protocol String
    (Updatable) Type of protocol used in virtual deployment.
    idleTimeoutInMs String
    (Updatable) The maximum duration in milliseconds for which the request's stream may be idle. The value 0 (zero) indicates that the timeout is disabled.
    requestTimeoutInMs String
    (Updatable) The maximum duration in milliseconds for the deployed service to respond to an incoming request through the listener. If provided, the timeout value overrides the default timeout of 15 seconds for the HTTP/HTTP2 listeners, and disabled (no timeout) for the GRPC listeners. The value 0 (zero) indicates that the timeout is disabled. The timeout cannot be configured for the TCP and TLS_PASSTHROUGH listeners. For streaming responses from the deployed service, consider either keeping the timeout disabled or set a sufficiently high value.
    port number
    (Updatable) Port in which virtual deployment is running.
    protocol string
    (Updatable) Type of protocol used in virtual deployment.
    idleTimeoutInMs string
    (Updatable) The maximum duration in milliseconds for which the request's stream may be idle. The value 0 (zero) indicates that the timeout is disabled.
    requestTimeoutInMs string
    (Updatable) The maximum duration in milliseconds for the deployed service to respond to an incoming request through the listener. If provided, the timeout value overrides the default timeout of 15 seconds for the HTTP/HTTP2 listeners, and disabled (no timeout) for the GRPC listeners. The value 0 (zero) indicates that the timeout is disabled. The timeout cannot be configured for the TCP and TLS_PASSTHROUGH listeners. For streaming responses from the deployed service, consider either keeping the timeout disabled or set a sufficiently high value.
    port int
    (Updatable) Port in which virtual deployment is running.
    protocol str
    (Updatable) Type of protocol used in virtual deployment.
    idle_timeout_in_ms str
    (Updatable) The maximum duration in milliseconds for which the request's stream may be idle. The value 0 (zero) indicates that the timeout is disabled.
    request_timeout_in_ms str
    (Updatable) The maximum duration in milliseconds for the deployed service to respond to an incoming request through the listener. If provided, the timeout value overrides the default timeout of 15 seconds for the HTTP/HTTP2 listeners, and disabled (no timeout) for the GRPC listeners. The value 0 (zero) indicates that the timeout is disabled. The timeout cannot be configured for the TCP and TLS_PASSTHROUGH listeners. For streaming responses from the deployed service, consider either keeping the timeout disabled or set a sufficiently high value.
    port Number
    (Updatable) Port in which virtual deployment is running.
    protocol String
    (Updatable) Type of protocol used in virtual deployment.
    idleTimeoutInMs String
    (Updatable) The maximum duration in milliseconds for which the request's stream may be idle. The value 0 (zero) indicates that the timeout is disabled.
    requestTimeoutInMs String
    (Updatable) The maximum duration in milliseconds for the deployed service to respond to an incoming request through the listener. If provided, the timeout value overrides the default timeout of 15 seconds for the HTTP/HTTP2 listeners, and disabled (no timeout) for the GRPC listeners. The value 0 (zero) indicates that the timeout is disabled. The timeout cannot be configured for the TCP and TLS_PASSTHROUGH listeners. For streaming responses from the deployed service, consider either keeping the timeout disabled or set a sufficiently high value.

    VirtualDeploymentServiceDiscovery, VirtualDeploymentServiceDiscoveryArgs

    Type string
    (Updatable) Type of service discovery.
    Hostname string
    (Updatable) The hostname of the virtual deployments.
    Type string
    (Updatable) Type of service discovery.
    Hostname string
    (Updatable) The hostname of the virtual deployments.
    type String
    (Updatable) Type of service discovery.
    hostname String
    (Updatable) The hostname of the virtual deployments.
    type string
    (Updatable) Type of service discovery.
    hostname string
    (Updatable) The hostname of the virtual deployments.
    type str
    (Updatable) Type of service discovery.
    hostname str
    (Updatable) The hostname of the virtual deployments.
    type String
    (Updatable) Type of service discovery.
    hostname String
    (Updatable) The hostname of the virtual deployments.

    Import

    VirtualDeployments can be imported using the id, e.g.

    $ pulumi import oci:ServiceMesh/virtualDeployment:VirtualDeployment test_virtual_deployment "id"
    

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

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi