1. Packages
  2. Consul Provider
  3. API Docs
  4. ConfigEntryV2ExportedServices
Consul v3.12.4 published on Wednesday, Feb 12, 2025 by Pulumi

consul.ConfigEntryV2ExportedServices

Explore with Pulumi AI

Create ConfigEntryV2ExportedServices Resource

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

Constructor syntax

new ConfigEntryV2ExportedServices(name: string, args: ConfigEntryV2ExportedServicesArgs, opts?: CustomResourceOptions);
@overload
def ConfigEntryV2ExportedServices(resource_name: str,
                                  args: ConfigEntryV2ExportedServicesArgs,
                                  opts: Optional[ResourceOptions] = None)

@overload
def ConfigEntryV2ExportedServices(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  kind: Optional[str] = None,
                                  partition: Optional[str] = None,
                                  name: Optional[str] = None,
                                  namespace: Optional[str] = None,
                                  partition_consumers: Optional[Sequence[str]] = None,
                                  peer_consumers: Optional[Sequence[str]] = None,
                                  sameness_group_consumers: Optional[Sequence[str]] = None,
                                  services: Optional[Sequence[str]] = None)
func NewConfigEntryV2ExportedServices(ctx *Context, name string, args ConfigEntryV2ExportedServicesArgs, opts ...ResourceOption) (*ConfigEntryV2ExportedServices, error)
public ConfigEntryV2ExportedServices(string name, ConfigEntryV2ExportedServicesArgs args, CustomResourceOptions? opts = null)
public ConfigEntryV2ExportedServices(String name, ConfigEntryV2ExportedServicesArgs args)
public ConfigEntryV2ExportedServices(String name, ConfigEntryV2ExportedServicesArgs args, CustomResourceOptions options)
type: consul:ConfigEntryV2ExportedServices
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ConfigEntryV2ExportedServicesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ConfigEntryV2ExportedServicesArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ConfigEntryV2ExportedServicesArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ConfigEntryV2ExportedServicesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ConfigEntryV2ExportedServicesArgs
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 configEntryV2ExportedServicesResource = new Consul.ConfigEntryV2ExportedServices("configEntryV2ExportedServicesResource", new()
{
    Kind = "string",
    Partition = "string",
    Name = "string",
    Namespace = "string",
    PartitionConsumers = new[]
    {
        "string",
    },
    PeerConsumers = new[]
    {
        "string",
    },
    SamenessGroupConsumers = new[]
    {
        "string",
    },
    Services = new[]
    {
        "string",
    },
});
Copy
example, err := consul.NewConfigEntryV2ExportedServices(ctx, "configEntryV2ExportedServicesResource", &consul.ConfigEntryV2ExportedServicesArgs{
	Kind:      pulumi.String("string"),
	Partition: pulumi.String("string"),
	Name:      pulumi.String("string"),
	Namespace: pulumi.String("string"),
	PartitionConsumers: pulumi.StringArray{
		pulumi.String("string"),
	},
	PeerConsumers: pulumi.StringArray{
		pulumi.String("string"),
	},
	SamenessGroupConsumers: pulumi.StringArray{
		pulumi.String("string"),
	},
	Services: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var configEntryV2ExportedServicesResource = new ConfigEntryV2ExportedServices("configEntryV2ExportedServicesResource", ConfigEntryV2ExportedServicesArgs.builder()
    .kind("string")
    .partition("string")
    .name("string")
    .namespace("string")
    .partitionConsumers("string")
    .peerConsumers("string")
    .samenessGroupConsumers("string")
    .services("string")
    .build());
Copy
config_entry_v2_exported_services_resource = consul.ConfigEntryV2ExportedServices("configEntryV2ExportedServicesResource",
    kind="string",
    partition="string",
    name="string",
    namespace="string",
    partition_consumers=["string"],
    peer_consumers=["string"],
    sameness_group_consumers=["string"],
    services=["string"])
Copy
const configEntryV2ExportedServicesResource = new consul.ConfigEntryV2ExportedServices("configEntryV2ExportedServicesResource", {
    kind: "string",
    partition: "string",
    name: "string",
    namespace: "string",
    partitionConsumers: ["string"],
    peerConsumers: ["string"],
    samenessGroupConsumers: ["string"],
    services: ["string"],
});
Copy
type: consul:ConfigEntryV2ExportedServices
properties:
    kind: string
    name: string
    namespace: string
    partition: string
    partitionConsumers:
        - string
    peerConsumers:
        - string
    samenessGroupConsumers:
        - string
    services:
        - string
Copy

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

Kind This property is required. string
The kind of exported services config (ExportedServices, NamespaceExportedServices, PartitionExportedServices).
Partition
This property is required.
Changes to this property will trigger replacement.
string
The partition the config entry is associated with.
Name string
The name of the config entry to read.
Namespace Changes to this property will trigger replacement. string
The namespace the config entry is associated with.
PartitionConsumers List<string>
The exported service partition consumers.
PeerConsumers List<string>
The exported service peer consumers.
SamenessGroupConsumers List<string>
The exported service sameness group consumers.
Services List<string>
The exported services.
Kind This property is required. string
The kind of exported services config (ExportedServices, NamespaceExportedServices, PartitionExportedServices).
Partition
This property is required.
Changes to this property will trigger replacement.
string
The partition the config entry is associated with.
Name string
The name of the config entry to read.
Namespace Changes to this property will trigger replacement. string
The namespace the config entry is associated with.
PartitionConsumers []string
The exported service partition consumers.
PeerConsumers []string
The exported service peer consumers.
SamenessGroupConsumers []string
The exported service sameness group consumers.
Services []string
The exported services.
kind This property is required. String
The kind of exported services config (ExportedServices, NamespaceExportedServices, PartitionExportedServices).
partition
This property is required.
Changes to this property will trigger replacement.
String
The partition the config entry is associated with.
name String
The name of the config entry to read.
namespace Changes to this property will trigger replacement. String
The namespace the config entry is associated with.
partitionConsumers List<String>
The exported service partition consumers.
peerConsumers List<String>
The exported service peer consumers.
samenessGroupConsumers List<String>
The exported service sameness group consumers.
services List<String>
The exported services.
kind This property is required. string
The kind of exported services config (ExportedServices, NamespaceExportedServices, PartitionExportedServices).
partition
This property is required.
Changes to this property will trigger replacement.
string
The partition the config entry is associated with.
name string
The name of the config entry to read.
namespace Changes to this property will trigger replacement. string
The namespace the config entry is associated with.
partitionConsumers string[]
The exported service partition consumers.
peerConsumers string[]
The exported service peer consumers.
samenessGroupConsumers string[]
The exported service sameness group consumers.
services string[]
The exported services.
kind This property is required. str
The kind of exported services config (ExportedServices, NamespaceExportedServices, PartitionExportedServices).
partition
This property is required.
Changes to this property will trigger replacement.
str
The partition the config entry is associated with.
name str
The name of the config entry to read.
namespace Changes to this property will trigger replacement. str
The namespace the config entry is associated with.
partition_consumers Sequence[str]
The exported service partition consumers.
peer_consumers Sequence[str]
The exported service peer consumers.
sameness_group_consumers Sequence[str]
The exported service sameness group consumers.
services Sequence[str]
The exported services.
kind This property is required. String
The kind of exported services config (ExportedServices, NamespaceExportedServices, PartitionExportedServices).
partition
This property is required.
Changes to this property will trigger replacement.
String
The partition the config entry is associated with.
name String
The name of the config entry to read.
namespace Changes to this property will trigger replacement. String
The namespace the config entry is associated with.
partitionConsumers List<String>
The exported service partition consumers.
peerConsumers List<String>
The exported service peer consumers.
samenessGroupConsumers List<String>
The exported service sameness group consumers.
services List<String>
The exported services.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ConfigEntryV2ExportedServices Resource

Get an existing ConfigEntryV2ExportedServices 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?: ConfigEntryV2ExportedServicesState, opts?: CustomResourceOptions): ConfigEntryV2ExportedServices
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        kind: Optional[str] = None,
        name: Optional[str] = None,
        namespace: Optional[str] = None,
        partition: Optional[str] = None,
        partition_consumers: Optional[Sequence[str]] = None,
        peer_consumers: Optional[Sequence[str]] = None,
        sameness_group_consumers: Optional[Sequence[str]] = None,
        services: Optional[Sequence[str]] = None) -> ConfigEntryV2ExportedServices
func GetConfigEntryV2ExportedServices(ctx *Context, name string, id IDInput, state *ConfigEntryV2ExportedServicesState, opts ...ResourceOption) (*ConfigEntryV2ExportedServices, error)
public static ConfigEntryV2ExportedServices Get(string name, Input<string> id, ConfigEntryV2ExportedServicesState? state, CustomResourceOptions? opts = null)
public static ConfigEntryV2ExportedServices get(String name, Output<String> id, ConfigEntryV2ExportedServicesState state, CustomResourceOptions options)
resources:  _:    type: consul:ConfigEntryV2ExportedServices    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Kind string
The kind of exported services config (ExportedServices, NamespaceExportedServices, PartitionExportedServices).
Name string
The name of the config entry to read.
Namespace Changes to this property will trigger replacement. string
The namespace the config entry is associated with.
Partition Changes to this property will trigger replacement. string
The partition the config entry is associated with.
PartitionConsumers List<string>
The exported service partition consumers.
PeerConsumers List<string>
The exported service peer consumers.
SamenessGroupConsumers List<string>
The exported service sameness group consumers.
Services List<string>
The exported services.
Kind string
The kind of exported services config (ExportedServices, NamespaceExportedServices, PartitionExportedServices).
Name string
The name of the config entry to read.
Namespace Changes to this property will trigger replacement. string
The namespace the config entry is associated with.
Partition Changes to this property will trigger replacement. string
The partition the config entry is associated with.
PartitionConsumers []string
The exported service partition consumers.
PeerConsumers []string
The exported service peer consumers.
SamenessGroupConsumers []string
The exported service sameness group consumers.
Services []string
The exported services.
kind String
The kind of exported services config (ExportedServices, NamespaceExportedServices, PartitionExportedServices).
name String
The name of the config entry to read.
namespace Changes to this property will trigger replacement. String
The namespace the config entry is associated with.
partition Changes to this property will trigger replacement. String
The partition the config entry is associated with.
partitionConsumers List<String>
The exported service partition consumers.
peerConsumers List<String>
The exported service peer consumers.
samenessGroupConsumers List<String>
The exported service sameness group consumers.
services List<String>
The exported services.
kind string
The kind of exported services config (ExportedServices, NamespaceExportedServices, PartitionExportedServices).
name string
The name of the config entry to read.
namespace Changes to this property will trigger replacement. string
The namespace the config entry is associated with.
partition Changes to this property will trigger replacement. string
The partition the config entry is associated with.
partitionConsumers string[]
The exported service partition consumers.
peerConsumers string[]
The exported service peer consumers.
samenessGroupConsumers string[]
The exported service sameness group consumers.
services string[]
The exported services.
kind str
The kind of exported services config (ExportedServices, NamespaceExportedServices, PartitionExportedServices).
name str
The name of the config entry to read.
namespace Changes to this property will trigger replacement. str
The namespace the config entry is associated with.
partition Changes to this property will trigger replacement. str
The partition the config entry is associated with.
partition_consumers Sequence[str]
The exported service partition consumers.
peer_consumers Sequence[str]
The exported service peer consumers.
sameness_group_consumers Sequence[str]
The exported service sameness group consumers.
services Sequence[str]
The exported services.
kind String
The kind of exported services config (ExportedServices, NamespaceExportedServices, PartitionExportedServices).
name String
The name of the config entry to read.
namespace Changes to this property will trigger replacement. String
The namespace the config entry is associated with.
partition Changes to this property will trigger replacement. String
The partition the config entry is associated with.
partitionConsumers List<String>
The exported service partition consumers.
peerConsumers List<String>
The exported service peer consumers.
samenessGroupConsumers List<String>
The exported service sameness group consumers.
services List<String>
The exported services.

Package Details

Repository
HashiCorp Consul pulumi/pulumi-consul
License
Apache-2.0
Notes
This Pulumi package is based on the consul Terraform Provider.