Docs Home
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
oci.Streaming.ConnectHarness
Explore with Pulumi AI
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("test_connect_harness", {
compartmentId: compartmentId,
name: connectHarnessName,
definedTags: connectHarnessDefinedTags,
freeformTags: {
Department: "Finance",
},
});
import pulumi
import pulumi_oci as oci
test_connect_harness = oci.streaming.ConnectHarness("test_connect_harness",
compartment_id=compartment_id,
name=connect_harness_name,
defined_tags=connect_harness_defined_tags,
freeform_tags={
"Department": "Finance",
})
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Streaming"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := Streaming.NewConnectHarness(ctx, "test_connect_harness", &Streaming.ConnectHarnessArgs{
CompartmentId: pulumi.Any(compartmentId),
Name: pulumi.Any(connectHarnessName),
DefinedTags: pulumi.Any(connectHarnessDefinedTags),
FreeformTags: pulumi.StringMap{
"Department": pulumi.String("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("test_connect_harness", new()
{
CompartmentId = compartmentId,
Name = connectHarnessName,
DefinedTags = connectHarnessDefinedTags,
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(compartmentId)
.name(connectHarnessName)
.definedTags(connectHarnessDefinedTags)
.freeformTags(Map.of("Department", "Finance"))
.build());
}
}
resources:
testConnectHarness:
type: oci:Streaming:ConnectHarness
name: test_connect_harness
properties:
compartmentId: ${compartmentId}
name: ${connectHarnessName}
definedTags: ${connectHarnessDefinedTags}
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, str]] = None,
freeform_tags: Optional[Mapping[str, str]] = 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var connectHarnessResource = new Oci.Streaming.ConnectHarness("connectHarnessResource", new()
{
CompartmentId = "string",
DefinedTags =
{
{ "string", "string" },
},
FreeformTags =
{
{ "string", "string" },
},
Name = "string",
});
example, err := Streaming.NewConnectHarness(ctx, "connectHarnessResource", &Streaming.ConnectHarnessArgs{
CompartmentId: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Name: pulumi.String("string"),
})
var connectHarnessResource = new ConnectHarness("connectHarnessResource", ConnectHarnessArgs.builder()
.compartmentId("string")
.definedTags(Map.of("string", "string"))
.freeformTags(Map.of("string", "string"))
.name("string")
.build());
connect_harness_resource = oci.streaming.ConnectHarness("connectHarnessResource",
compartment_id="string",
defined_tags={
"string": "string",
},
freeform_tags={
"string": "string",
},
name="string")
const connectHarnessResource = new oci.streaming.ConnectHarness("connectHarnessResource", {
compartmentId: "string",
definedTags: {
string: "string",
},
freeformTags: {
string: "string",
},
name: "string",
});
type: oci:Streaming:ConnectHarness
properties:
compartmentId: string
definedTags:
string: string
freeformTags:
string: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ConnectHarness resource accepts the following input properties:
- Compartment
Id string - (Updatable) The OCID of the compartment that contains the connect harness.
- Dictionary<string, string>
- (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"} - Dictionary<string, string>
- (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 string - (Updatable) The OCID of the compartment that contains the connect harness.
- map[string]string
- (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"} - map[string]string
- (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 String - (Updatable) The OCID of the compartment that contains the connect harness.
- Map<String,String>
- (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"} - Map<String,String>
- (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 string - (Updatable) The OCID of the compartment that contains the connect harness.
- {[key: string]: string}
- (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"} - {[key: string]: string}
- (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.
- Mapping[str, str]
- (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"} - Mapping[str, str]
- (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
- compartment
Id String - (Updatable) The OCID of the compartment that contains the connect harness.
- Map<String>
- (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"} - Map<String>
- (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.
- Lifecycle
State stringDetails - Any additional details about the current state of the connect harness.
- State string
- The current state of the connect harness.
- Time
Created 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.
- Lifecycle
State stringDetails - Any additional details about the current state of the connect harness.
- State string
- The current state of the connect harness.
- Time
Created 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.
- lifecycle
State StringDetails - Any additional details about the current state of the connect harness.
- state String
- The current state of the connect harness.
- time
Created 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.
- lifecycle
State stringDetails - Any additional details about the current state of the connect harness.
- state string
- The current state of the connect harness.
- time
Created 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_ strdetails - 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.
- lifecycle
State StringDetails - Any additional details about the current state of the connect harness.
- state String
- The current state of the connect harness.
- time
Created 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, str]] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
lifecycle_state_details: Optional[str] = None,
name: Optional[str] = None,
state: Optional[str] = None,
time_created: Optional[str] = None) -> ConnectHarnessfunc 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.
- Compartment
Id string - (Updatable) The OCID of the compartment that contains the connect harness.
- Dictionary<string, string>
- (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"} - Dictionary<string, string>
- (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 stringDetails - 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.
- Time
Created 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 string - (Updatable) The OCID of the compartment that contains the connect harness.
- map[string]string
- (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"} - map[string]string
- (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 stringDetails - 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.
- Time
Created 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 String - (Updatable) The OCID of the compartment that contains the connect harness.
- Map<String,String>
- (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"} - Map<String,String>
- (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 StringDetails - 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.
- time
Created 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 string - (Updatable) The OCID of the compartment that contains the connect harness.
- {[key: string]: string}
- (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"} - {[key: string]: string}
- (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 stringDetails - 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.
- time
Created 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.
- Mapping[str, str]
- (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"} - Mapping[str, str]
- (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_ strdetails - 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
- compartment
Id String - (Updatable) The OCID of the compartment that contains the connect harness.
- Map<String>
- (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"} - Map<String>
- (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 StringDetails - 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.
- time
Created 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
ociTerraform Provider.