1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Streaming
  5. ConnectHarness
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

oci.Streaming.ConnectHarness

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

    This resource provides the Connect Harness resource in Oracle Cloud Infrastructure Streaming service.

    Starts the provisioning of a new connect harness. To track the progress of the provisioning, you can periodically call [GetConnectHarness]. In the response, the lifecycleState parameter of the ConnectHarness object tells you its current state.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testConnectHarness = new oci.streaming.ConnectHarness("testConnectHarness", {
        compartmentId: _var.compartment_id,
        definedTags: _var.connect_harness_defined_tags,
        freeformTags: {
            Department: "Finance",
        },
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_connect_harness = oci.streaming.ConnectHarness("testConnectHarness",
        compartment_id=var["compartment_id"],
        defined_tags=var["connect_harness_defined_tags"],
        freeform_tags={
            "Department": "Finance",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Streaming"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Streaming.NewConnectHarness(ctx, "testConnectHarness", &Streaming.ConnectHarnessArgs{
    			CompartmentId: pulumi.Any(_var.Compartment_id),
    			DefinedTags:   pulumi.Any(_var.Connect_harness_defined_tags),
    			FreeformTags: pulumi.Map{
    				"Department": pulumi.Any("Finance"),
    			},
    		})
    		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 testConnectHarness = new Oci.Streaming.ConnectHarness("testConnectHarness", new()
        {
            CompartmentId = @var.Compartment_id,
            DefinedTags = @var.Connect_harness_defined_tags,
            FreeformTags = 
            {
                { "Department", "Finance" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Streaming.ConnectHarness;
    import com.pulumi.oci.Streaming.ConnectHarnessArgs;
    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 testConnectHarness = new ConnectHarness("testConnectHarness", ConnectHarnessArgs.builder()        
                .compartmentId(var_.compartment_id())
                .definedTags(var_.connect_harness_defined_tags())
                .freeformTags(Map.of("Department", "Finance"))
                .build());
    
        }
    }
    
    resources:
      testConnectHarness:
        type: oci:Streaming:ConnectHarness
        properties:
          #Required
          compartmentId: ${var.compartment_id}
          #Optional
          definedTags: ${var.connect_harness_defined_tags}
          freeformTags:
            Department: Finance
    

    Create ConnectHarness Resource

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

    Constructor syntax

    new ConnectHarness(name: string, args: ConnectHarnessArgs, opts?: CustomResourceOptions);
    @overload
    def ConnectHarness(resource_name: str,
                       args: ConnectHarnessArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def ConnectHarness(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       compartment_id: Optional[str] = None,
                       defined_tags: Optional[Mapping[str, Any]] = None,
                       freeform_tags: Optional[Mapping[str, Any]] = None,
                       name: Optional[str] = None)
    func NewConnectHarness(ctx *Context, name string, args ConnectHarnessArgs, opts ...ResourceOption) (*ConnectHarness, error)
    public ConnectHarness(string name, ConnectHarnessArgs args, CustomResourceOptions? opts = null)
    public ConnectHarness(String name, ConnectHarnessArgs args)
    public ConnectHarness(String name, ConnectHarnessArgs args, CustomResourceOptions options)
    
    type: oci:Streaming:ConnectHarness
    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 ConnectHarnessArgs
    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 ConnectHarnessArgs
    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 ConnectHarnessArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectHarnessArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectHarnessArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var connectHarnessResource = new Oci.Streaming.ConnectHarness("connectHarnessResource", new()
    {
        CompartmentId = "string",
        DefinedTags = 
        {
            { "string", "any" },
        },
        FreeformTags = 
        {
            { "string", "any" },
        },
        Name = "string",
    });
    
    example, err := Streaming.NewConnectHarness(ctx, "connectHarnessResource", &Streaming.ConnectHarnessArgs{
    	CompartmentId: pulumi.String("string"),
    	DefinedTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	FreeformTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	Name: pulumi.String("string"),
    })
    
    var connectHarnessResource = new ConnectHarness("connectHarnessResource", ConnectHarnessArgs.builder()        
        .compartmentId("string")
        .definedTags(Map.of("string", "any"))
        .freeformTags(Map.of("string", "any"))
        .name("string")
        .build());
    
    connect_harness_resource = oci.streaming.ConnectHarness("connectHarnessResource",
        compartment_id="string",
        defined_tags={
            "string": "any",
        },
        freeform_tags={
            "string": "any",
        },
        name="string")
    
    const connectHarnessResource = new oci.streaming.ConnectHarness("connectHarnessResource", {
        compartmentId: "string",
        definedTags: {
            string: "any",
        },
        freeformTags: {
            string: "any",
        },
        name: "string",
    });
    
    type: oci:Streaming:ConnectHarness
    properties:
        compartmentId: string
        definedTags:
            string: any
        freeformTags:
            string: any
        name: string
    

    ConnectHarness Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ConnectHarness resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment that contains the connect harness.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    FreeformTags Dictionary<string, object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Name string

    The name of the connect harness. Avoid entering confidential information. Example: JDBCConnector

    ** 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

    CompartmentId string
    (Updatable) The OCID of the compartment that contains the connect harness.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    FreeformTags map[string]interface{}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Name string

    The name of the connect harness. Avoid entering confidential information. Example: JDBCConnector

    ** 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

    compartmentId String
    (Updatable) The OCID of the compartment that contains the connect harness.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformTags Map<String,Object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    name String

    The name of the connect harness. Avoid entering confidential information. Example: JDBCConnector

    ** 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

    compartmentId string
    (Updatable) The OCID of the compartment that contains the connect harness.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformTags {[key: string]: any}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    name string

    The name of the connect harness. Avoid entering confidential information. Example: JDBCConnector

    ** 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

    compartment_id str
    (Updatable) The OCID of the compartment that contains the connect harness.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeform_tags Mapping[str, Any]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    name str

    The name of the connect harness. Avoid entering confidential information. Example: JDBCConnector

    ** 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

    compartmentId String
    (Updatable) The OCID of the compartment that contains the connect harness.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformTags Map<Any>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    name String

    The name of the connect harness. Avoid entering confidential information. Example: JDBCConnector

    ** 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

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleStateDetails string
    Any additional details about the current state of the connect harness.
    State string
    The current state of the connect harness.
    TimeCreated string
    The date and time the connect harness was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleStateDetails string
    Any additional details about the current state of the connect harness.
    State string
    The current state of the connect harness.
    TimeCreated string
    The date and time the connect harness was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleStateDetails String
    Any additional details about the current state of the connect harness.
    state String
    The current state of the connect harness.
    timeCreated String
    The date and time the connect harness was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleStateDetails string
    Any additional details about the current state of the connect harness.
    state string
    The current state of the connect harness.
    timeCreated string
    The date and time the connect harness was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_state_details str
    Any additional details about the current state of the connect harness.
    state str
    The current state of the connect harness.
    time_created str
    The date and time the connect harness was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleStateDetails String
    Any additional details about the current state of the connect harness.
    state String
    The current state of the connect harness.
    timeCreated String
    The date and time the connect harness was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z

    Look up Existing ConnectHarness Resource

    Get an existing ConnectHarness 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?: ConnectHarnessState, opts?: CustomResourceOptions): ConnectHarness
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            lifecycle_state_details: Optional[str] = None,
            name: Optional[str] = None,
            state: Optional[str] = None,
            time_created: Optional[str] = None) -> ConnectHarness
    func GetConnectHarness(ctx *Context, name string, id IDInput, state *ConnectHarnessState, opts ...ResourceOption) (*ConnectHarness, error)
    public static ConnectHarness Get(string name, Input<string> id, ConnectHarnessState? state, CustomResourceOptions? opts = null)
    public static ConnectHarness get(String name, Output<String> id, ConnectHarnessState 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:
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the connect harness.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    FreeformTags Dictionary<string, object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    LifecycleStateDetails string
    Any additional details about the current state of the connect harness.
    Name string

    The name of the connect harness. Avoid entering confidential information. Example: JDBCConnector

    ** 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

    State string
    The current state of the connect harness.
    TimeCreated string
    The date and time the connect harness was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the connect harness.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    FreeformTags map[string]interface{}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    LifecycleStateDetails string
    Any additional details about the current state of the connect harness.
    Name string

    The name of the connect harness. Avoid entering confidential information. Example: JDBCConnector

    ** 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

    State string
    The current state of the connect harness.
    TimeCreated string
    The date and time the connect harness was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    compartmentId String
    (Updatable) The OCID of the compartment that contains the connect harness.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformTags Map<String,Object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycleStateDetails String
    Any additional details about the current state of the connect harness.
    name String

    The name of the connect harness. Avoid entering confidential information. Example: JDBCConnector

    ** 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

    state String
    The current state of the connect harness.
    timeCreated String
    The date and time the connect harness was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    compartmentId string
    (Updatable) The OCID of the compartment that contains the connect harness.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformTags {[key: string]: any}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycleStateDetails string
    Any additional details about the current state of the connect harness.
    name string

    The name of the connect harness. Avoid entering confidential information. Example: JDBCConnector

    ** 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

    state string
    The current state of the connect harness.
    timeCreated string
    The date and time the connect harness was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    compartment_id str
    (Updatable) The OCID of the compartment that contains the connect harness.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeform_tags Mapping[str, Any]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycle_state_details str
    Any additional details about the current state of the connect harness.
    name str

    The name of the connect harness. Avoid entering confidential information. Example: JDBCConnector

    ** 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

    state str
    The current state of the connect harness.
    time_created str
    The date and time the connect harness was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    compartmentId String
    (Updatable) The OCID of the compartment that contains the connect harness.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformTags Map<Any>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycleStateDetails String
    Any additional details about the current state of the connect harness.
    name String

    The name of the connect harness. Avoid entering confidential information. Example: JDBCConnector

    ** 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

    state String
    The current state of the connect harness.
    timeCreated String
    The date and time the connect harness was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z

    Import

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

    $ pulumi import oci:Streaming/connectHarness:ConnectHarness test_connect_harness "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 v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi