Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vsphere Provider
  3. API Docs
  4. ConfigurationProfile
vSphere v4.16.0 published on Saturday, Aug 23, 2025 by Pulumi
pulumi/pulumi-vsphere

vsphere.ConfigurationProfile

Explore with Pulumi AI

vsphere logo
vSphere v4.16.0 published on Saturday, Aug 23, 2025 by Pulumi
pulumi/pulumi-vsphere

    Create ConfigurationProfile Resource

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

    Constructor syntax

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

@overload
def ConfigurationProfile(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         cluster_id: Optional[str] = None,
                         configuration: Optional[str] = None,
                         reference_host_id: Optional[str] = None)
    func NewConfigurationProfile(ctx *Context, name string, args ConfigurationProfileArgs, opts ...ResourceOption) (*ConfigurationProfile, error)
    public ConfigurationProfile(string name, ConfigurationProfileArgs args, CustomResourceOptions? opts = null)
    public ConfigurationProfile(String name, ConfigurationProfileArgs args)
public ConfigurationProfile(String name, ConfigurationProfileArgs args, CustomResourceOptions options)

    type: vsphere:ConfigurationProfile
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 ConfigurationProfileArgs
    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 ConfigurationProfileArgs
    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 ConfigurationProfileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConfigurationProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConfigurationProfileArgs
    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 configurationProfileResource = new VSphere.ConfigurationProfile("configurationProfileResource", new()
{
    ClusterId = "string",
    Configuration = "string",
    ReferenceHostId = "string",
});

    example, err := vsphere.NewConfigurationProfile(ctx, "configurationProfileResource", &vsphere.ConfigurationProfileArgs{
	ClusterId:       pulumi.String("string"),
	Configuration:   pulumi.String("string"),
	ReferenceHostId: pulumi.String("string"),
})

    var configurationProfileResource = new ConfigurationProfile("configurationProfileResource", ConfigurationProfileArgs.builder()
    .clusterId("string")
    .configuration("string")
    .referenceHostId("string")
    .build());

    configuration_profile_resource = vsphere.ConfigurationProfile("configurationProfileResource",
    cluster_id="string",
    configuration="string",
    reference_host_id="string")

    const configurationProfileResource = new vsphere.ConfigurationProfile("configurationProfileResource", {
    clusterId: "string",
    configuration: "string",
    referenceHostId: "string",
});

    type: vsphere:ConfigurationProfile
properties:
    clusterId: string
    configuration: string
    referenceHostId: string

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

    ClusterId string
    The identifier of the cluster.
    Configuration string
    The configuration JSON provided as a plain string. This argument can only be specified if reference_host_id is not set.
    ReferenceHostId string
    The identifier of the host to use as a configuration source. The host needs to be a member of the cluster identified by cluster_id. This argument can only be specified if configuration is not set.
    ClusterId string
    The identifier of the cluster.
    Configuration string
    The configuration JSON provided as a plain string. This argument can only be specified if reference_host_id is not set.
    ReferenceHostId string
    The identifier of the host to use as a configuration source. The host needs to be a member of the cluster identified by cluster_id. This argument can only be specified if configuration is not set.
    clusterId String
    The identifier of the cluster.
    configuration String
    The configuration JSON provided as a plain string. This argument can only be specified if reference_host_id is not set.
    referenceHostId String
    The identifier of the host to use as a configuration source. The host needs to be a member of the cluster identified by cluster_id. This argument can only be specified if configuration is not set.
    clusterId string
    The identifier of the cluster.
    configuration string
    The configuration JSON provided as a plain string. This argument can only be specified if reference_host_id is not set.
    referenceHostId string
    The identifier of the host to use as a configuration source. The host needs to be a member of the cluster identified by cluster_id. This argument can only be specified if configuration is not set.
    cluster_id str
    The identifier of the cluster.
    configuration str
    The configuration JSON provided as a plain string. This argument can only be specified if reference_host_id is not set.
    reference_host_id str
    The identifier of the host to use as a configuration source. The host needs to be a member of the cluster identified by cluster_id. This argument can only be specified if configuration is not set.
    clusterId String
    The identifier of the cluster.
    configuration String
    The configuration JSON provided as a plain string. This argument can only be specified if reference_host_id is not set.
    referenceHostId String
    The identifier of the host to use as a configuration source. The host needs to be a member of the cluster identified by cluster_id. This argument can only be specified if configuration is not set.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Schema string
    The JSON schema for the profile.
    Id string
    The provider-assigned unique ID for this managed resource.
    Schema string
    The JSON schema for the profile.
    id String
    The provider-assigned unique ID for this managed resource.
    schema String
    The JSON schema for the profile.
    id string
    The provider-assigned unique ID for this managed resource.
    schema string
    The JSON schema for the profile.
    id str
    The provider-assigned unique ID for this managed resource.
    schema str
    The JSON schema for the profile.
    id String
    The provider-assigned unique ID for this managed resource.
    schema String
    The JSON schema for the profile.

    Look up Existing ConfigurationProfile Resource

    Get an existing ConfigurationProfile 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?: ConfigurationProfileState, opts?: CustomResourceOptions): ConfigurationProfile
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        configuration: Optional[str] = None,
        reference_host_id: Optional[str] = None,
        schema: Optional[str] = None) -> ConfigurationProfile
    func GetConfigurationProfile(ctx *Context, name string, id IDInput, state *ConfigurationProfileState, opts ...ResourceOption) (*ConfigurationProfile, error)
    public static ConfigurationProfile Get(string name, Input<string> id, ConfigurationProfileState? state, CustomResourceOptions? opts = null)
    public static ConfigurationProfile get(String name, Output<String> id, ConfigurationProfileState state, CustomResourceOptions options)
    resources:  _:    type: vsphere:ConfigurationProfile    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ClusterId string
    The identifier of the cluster.
    Configuration string
    The configuration JSON provided as a plain string. This argument can only be specified if reference_host_id is not set.
    ReferenceHostId string
    The identifier of the host to use as a configuration source. The host needs to be a member of the cluster identified by cluster_id. This argument can only be specified if configuration is not set.
    Schema string
    The JSON schema for the profile.
    ClusterId string
    The identifier of the cluster.
    Configuration string
    The configuration JSON provided as a plain string. This argument can only be specified if reference_host_id is not set.
    ReferenceHostId string
    The identifier of the host to use as a configuration source. The host needs to be a member of the cluster identified by cluster_id. This argument can only be specified if configuration is not set.
    Schema string
    The JSON schema for the profile.
    clusterId String
    The identifier of the cluster.
    configuration String
    The configuration JSON provided as a plain string. This argument can only be specified if reference_host_id is not set.
    referenceHostId String
    The identifier of the host to use as a configuration source. The host needs to be a member of the cluster identified by cluster_id. This argument can only be specified if configuration is not set.
    schema String
    The JSON schema for the profile.
    clusterId string
    The identifier of the cluster.
    configuration string
    The configuration JSON provided as a plain string. This argument can only be specified if reference_host_id is not set.
    referenceHostId string
    The identifier of the host to use as a configuration source. The host needs to be a member of the cluster identified by cluster_id. This argument can only be specified if configuration is not set.
    schema string
    The JSON schema for the profile.
    cluster_id str
    The identifier of the cluster.
    configuration str
    The configuration JSON provided as a plain string. This argument can only be specified if reference_host_id is not set.
    reference_host_id str
    The identifier of the host to use as a configuration source. The host needs to be a member of the cluster identified by cluster_id. This argument can only be specified if configuration is not set.
    schema str
    The JSON schema for the profile.
    clusterId String
    The identifier of the cluster.
    configuration String
    The configuration JSON provided as a plain string. This argument can only be specified if reference_host_id is not set.
    referenceHostId String
    The identifier of the host to use as a configuration source. The host needs to be a member of the cluster identified by cluster_id. This argument can only be specified if configuration is not set.
    schema String
    The JSON schema for the profile.

    Package Details

    Repository
    vSphere pulumi/pulumi-vsphere
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vsphere Terraform Provider.
    vsphere logo
    vSphere v4.16.0 published on Saturday, Aug 23, 2025 by Pulumi
    pulumi/pulumi-vsphere