1. Packages
  2. Nutanix
  3. API Docs
  4. FoundationCentralApiKeys
Nutanix v0.0.52 published on Friday, Jun 7, 2024 by Piers Karsenbarg

nutanix.FoundationCentralApiKeys

Explore with Pulumi AI

nutanix logo
Nutanix v0.0.52 published on Friday, Jun 7, 2024 by Piers Karsenbarg

    Provides a resource to create a new API key for nodes registration with Foundation Central.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as nutanix from "@pierskarsenbarg/nutanix";
    
    const newApiKey = new nutanix.FoundationCentralApiKeys("newApiKey", {alias: "<NAME-FOR-API-KEY>"});
    
    import pulumi
    import pulumi_nutanix as nutanix
    
    new_api_key = nutanix.FoundationCentralApiKeys("newApiKey", alias="<NAME-FOR-API-KEY>")
    
    package main
    
    import (
    	"github.com/pierskarsenbarg/pulumi-nutanix/sdk/go/nutanix"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := nutanix.NewFoundationCentralApiKeys(ctx, "newApiKey", &nutanix.FoundationCentralApiKeysArgs{
    			Alias: pulumi.String("<NAME-FOR-API-KEY>"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nutanix = PiersKarsenbarg.Nutanix;
    
    return await Deployment.RunAsync(() => 
    {
        var newApiKey = new Nutanix.FoundationCentralApiKeys("newApiKey", new()
        {
            Alias = "<NAME-FOR-API-KEY>",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nutanix.FoundationCentralApiKeys;
    import com.pulumi.nutanix.FoundationCentralApiKeysArgs;
    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 newApiKey = new FoundationCentralApiKeys("newApiKey", FoundationCentralApiKeysArgs.builder()
                .alias("<NAME-FOR-API-KEY>")
                .build());
    
        }
    }
    
    resources:
      newApiKey:
        type: nutanix:FoundationCentralApiKeys
        properties:
          alias: <NAME-FOR-API-KEY>
    

    Create FoundationCentralApiKeys Resource

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

    Constructor syntax

    new FoundationCentralApiKeys(name: string, args: FoundationCentralApiKeysArgs, opts?: CustomResourceOptions);
    @overload
    def FoundationCentralApiKeys(resource_name: str,
                                 args: FoundationCentralApiKeysArgs,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def FoundationCentralApiKeys(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 alias: Optional[str] = None)
    func NewFoundationCentralApiKeys(ctx *Context, name string, args FoundationCentralApiKeysArgs, opts ...ResourceOption) (*FoundationCentralApiKeys, error)
    public FoundationCentralApiKeys(string name, FoundationCentralApiKeysArgs args, CustomResourceOptions? opts = null)
    public FoundationCentralApiKeys(String name, FoundationCentralApiKeysArgs args)
    public FoundationCentralApiKeys(String name, FoundationCentralApiKeysArgs args, CustomResourceOptions options)
    
    type: nutanix:FoundationCentralApiKeys
    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 FoundationCentralApiKeysArgs
    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 FoundationCentralApiKeysArgs
    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 FoundationCentralApiKeysArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FoundationCentralApiKeysArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FoundationCentralApiKeysArgs
    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 foundationCentralApiKeysResource = new Nutanix.FoundationCentralApiKeys("foundationCentralApiKeysResource", new()
    {
        Alias = "string",
    });
    
    example, err := nutanix.NewFoundationCentralApiKeys(ctx, "foundationCentralApiKeysResource", &nutanix.FoundationCentralApiKeysArgs{
    	Alias: pulumi.String("string"),
    })
    
    var foundationCentralApiKeysResource = new FoundationCentralApiKeys("foundationCentralApiKeysResource", FoundationCentralApiKeysArgs.builder()
        .alias("string")
        .build());
    
    foundation_central_api_keys_resource = nutanix.FoundationCentralApiKeys("foundationCentralApiKeysResource", alias="string")
    
    const foundationCentralApiKeysResource = new nutanix.FoundationCentralApiKeys("foundationCentralApiKeysResource", {alias: "string"});
    
    type: nutanix:FoundationCentralApiKeys
    properties:
        alias: string
    

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

    Alias string
    • (Required) Alias for the api key to be created.
    Alias string
    • (Required) Alias for the api key to be created.
    alias String
    • (Required) Alias for the api key to be created.
    alias string
    • (Required) Alias for the api key to be created.
    alias str
    • (Required) Alias for the api key to be created.
    alias String
    • (Required) Alias for the api key to be created.

    Outputs

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

    ApiKey string
    Api key in string format.
    CreatedTimestamp string
    Time when the api key was created.
    CurrentTime string
    Current time of Foundation Central.
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyUuid string
    UUID of the api key.
    ApiKey string
    Api key in string format.
    CreatedTimestamp string
    Time when the api key was created.
    CurrentTime string
    Current time of Foundation Central.
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyUuid string
    UUID of the api key.
    apiKey String
    Api key in string format.
    createdTimestamp String
    Time when the api key was created.
    currentTime String
    Current time of Foundation Central.
    id String
    The provider-assigned unique ID for this managed resource.
    keyUuid String
    UUID of the api key.
    apiKey string
    Api key in string format.
    createdTimestamp string
    Time when the api key was created.
    currentTime string
    Current time of Foundation Central.
    id string
    The provider-assigned unique ID for this managed resource.
    keyUuid string
    UUID of the api key.
    api_key str
    Api key in string format.
    created_timestamp str
    Time when the api key was created.
    current_time str
    Current time of Foundation Central.
    id str
    The provider-assigned unique ID for this managed resource.
    key_uuid str
    UUID of the api key.
    apiKey String
    Api key in string format.
    createdTimestamp String
    Time when the api key was created.
    currentTime String
    Current time of Foundation Central.
    id String
    The provider-assigned unique ID for this managed resource.
    keyUuid String
    UUID of the api key.

    Look up Existing FoundationCentralApiKeys Resource

    Get an existing FoundationCentralApiKeys 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?: FoundationCentralApiKeysState, opts?: CustomResourceOptions): FoundationCentralApiKeys
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            alias: Optional[str] = None,
            api_key: Optional[str] = None,
            created_timestamp: Optional[str] = None,
            current_time: Optional[str] = None,
            key_uuid: Optional[str] = None) -> FoundationCentralApiKeys
    func GetFoundationCentralApiKeys(ctx *Context, name string, id IDInput, state *FoundationCentralApiKeysState, opts ...ResourceOption) (*FoundationCentralApiKeys, error)
    public static FoundationCentralApiKeys Get(string name, Input<string> id, FoundationCentralApiKeysState? state, CustomResourceOptions? opts = null)
    public static FoundationCentralApiKeys get(String name, Output<String> id, FoundationCentralApiKeysState 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:
    Alias string
    • (Required) Alias for the api key to be created.
    ApiKey string
    Api key in string format.
    CreatedTimestamp string
    Time when the api key was created.
    CurrentTime string
    Current time of Foundation Central.
    KeyUuid string
    UUID of the api key.
    Alias string
    • (Required) Alias for the api key to be created.
    ApiKey string
    Api key in string format.
    CreatedTimestamp string
    Time when the api key was created.
    CurrentTime string
    Current time of Foundation Central.
    KeyUuid string
    UUID of the api key.
    alias String
    • (Required) Alias for the api key to be created.
    apiKey String
    Api key in string format.
    createdTimestamp String
    Time when the api key was created.
    currentTime String
    Current time of Foundation Central.
    keyUuid String
    UUID of the api key.
    alias string
    • (Required) Alias for the api key to be created.
    apiKey string
    Api key in string format.
    createdTimestamp string
    Time when the api key was created.
    currentTime string
    Current time of Foundation Central.
    keyUuid string
    UUID of the api key.
    alias str
    • (Required) Alias for the api key to be created.
    api_key str
    Api key in string format.
    created_timestamp str
    Time when the api key was created.
    current_time str
    Current time of Foundation Central.
    key_uuid str
    UUID of the api key.
    alias String
    • (Required) Alias for the api key to be created.
    apiKey String
    Api key in string format.
    createdTimestamp String
    Time when the api key was created.
    currentTime String
    Current time of Foundation Central.
    keyUuid String
    UUID of the api key.

    Package Details

    Repository
    nutanix pierskarsenbarg/pulumi-nutanix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nutanix Terraform Provider.
    nutanix logo
    Nutanix v0.0.52 published on Friday, Jun 7, 2024 by Piers Karsenbarg