Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. pgEdge
  3. API Docs
  4. Cluster
pgEdge v0.0.40 published on Friday, Jan 10, 2025 by pgEdge
pgEdge/pulumi-pgedge

pgedge.Cluster

Explore with Pulumi AI

pgedge logo
pgEdge v0.0.40 published on Friday, Jan 10, 2025 by pgEdge
pgEdge/pulumi-pgedge

    Create Cluster Resource

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

    Constructor syntax

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

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            cloud_account_id: Optional[str] = None,
            networks: Optional[Sequence[ClusterNetworkArgs]] = None,
            node_location: Optional[str] = None,
            nodes: Optional[Sequence[ClusterNodeArgs]] = None,
            regions: Optional[Sequence[str]] = None,
            backup_store_ids: Optional[Sequence[str]] = None,
            capacity: Optional[int] = None,
            firewall_rules: Optional[Sequence[ClusterFirewallRuleArgs]] = None,
            name: Optional[str] = None,
            resource_tags: Optional[Mapping[str, str]] = None,
            ssh_key_id: Optional[str] = None)
    func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
    public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
    public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)

    type: pgedge:Cluster
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 ClusterArgs
    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 ClusterArgs
    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 ClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterArgs
    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 clusterResource = new Pgedge.Cluster("clusterResource", new()
{
    CloudAccountId = "string",
    Networks = new[]
    {
        new Pgedge.Inputs.ClusterNetworkArgs
        {
            Cidr = "string",
            PublicSubnets = new[]
            {
                "string",
            },
            Region = "string",
            External = false,
            ExternalId = "string",
            Name = "string",
            PrivateSubnets = new[]
            {
                "string",
            },
        },
    },
    NodeLocation = "string",
    Nodes = new[]
    {
        new Pgedge.Inputs.ClusterNodeArgs
        {
            InstanceType = "string",
            Name = "string",
            Region = "string",
            AvailabilityZone = "string",
            VolumeIops = 0,
            VolumeSize = 0,
            VolumeType = "string",
        },
    },
    Regions = new[]
    {
        "string",
    },
    BackupStoreIds = new[]
    {
        "string",
    },
    Capacity = 0,
    FirewallRules = new[]
    {
        new Pgedge.Inputs.ClusterFirewallRuleArgs
        {
            Name = "string",
            Port = 0,
            Sources = new[]
            {
                "string",
            },
        },
    },
    Name = "string",
    ResourceTags = 
    {
        { "string", "string" },
    },
    SshKeyId = "string",
});

    example, err := pgedge.NewCluster(ctx, "clusterResource", &pgedge.ClusterArgs{
	CloudAccountId: pulumi.String("string"),
	Networks: pgedge.ClusterNetworkArray{
		&pgedge.ClusterNetworkArgs{
			Cidr: pulumi.String("string"),
			PublicSubnets: pulumi.StringArray{
				pulumi.String("string"),
			},
			Region:     pulumi.String("string"),
			External:   pulumi.Bool(false),
			ExternalId: pulumi.String("string"),
			Name:       pulumi.String("string"),
			PrivateSubnets: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	NodeLocation: pulumi.String("string"),
	Nodes: pgedge.ClusterNodeArray{
		&pgedge.ClusterNodeArgs{
			InstanceType:     pulumi.String("string"),
			Name:             pulumi.String("string"),
			Region:           pulumi.String("string"),
			AvailabilityZone: pulumi.String("string"),
			VolumeIops:       pulumi.Int(0),
			VolumeSize:       pulumi.Int(0),
			VolumeType:       pulumi.String("string"),
		},
	},
	Regions: pulumi.StringArray{
		pulumi.String("string"),
	},
	BackupStoreIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Capacity: pulumi.Int(0),
	FirewallRules: pgedge.ClusterFirewallRuleArray{
		&pgedge.ClusterFirewallRuleArgs{
			Name: pulumi.String("string"),
			Port: pulumi.Int(0),
			Sources: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Name: pulumi.String("string"),
	ResourceTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	SshKeyId: pulumi.String("string"),
})

    var clusterResource = new Cluster("clusterResource", ClusterArgs.builder()
    .cloudAccountId("string")
    .networks(ClusterNetworkArgs.builder()
        .cidr("string")
        .publicSubnets("string")
        .region("string")
        .external(false)
        .externalId("string")
        .name("string")
        .privateSubnets("string")
        .build())
    .nodeLocation("string")
    .nodes(ClusterNodeArgs.builder()
        .instanceType("string")
        .name("string")
        .region("string")
        .availabilityZone("string")
        .volumeIops(0)
        .volumeSize(0)
        .volumeType("string")
        .build())
    .regions("string")
    .backupStoreIds("string")
    .capacity(0)
    .firewallRules(ClusterFirewallRuleArgs.builder()
        .name("string")
        .port(0)
        .sources("string")
        .build())
    .name("string")
    .resourceTags(Map.of("string", "string"))
    .sshKeyId("string")
    .build());

    cluster_resource = pgedge.Cluster("clusterResource",
    cloud_account_id="string",
    networks=[{
        "cidr": "string",
        "public_subnets": ["string"],
        "region": "string",
        "external": False,
        "external_id": "string",
        "name": "string",
        "private_subnets": ["string"],
    }],
    node_location="string",
    nodes=[{
        "instance_type": "string",
        "name": "string",
        "region": "string",
        "availability_zone": "string",
        "volume_iops": 0,
        "volume_size": 0,
        "volume_type": "string",
    }],
    regions=["string"],
    backup_store_ids=["string"],
    capacity=0,
    firewall_rules=[{
        "name": "string",
        "port": 0,
        "sources": ["string"],
    }],
    name="string",
    resource_tags={
        "string": "string",
    },
    ssh_key_id="string")

    const clusterResource = new pgedge.Cluster("clusterResource", {
    cloudAccountId: "string",
    networks: [{
        cidr: "string",
        publicSubnets: ["string"],
        region: "string",
        external: false,
        externalId: "string",
        name: "string",
        privateSubnets: ["string"],
    }],
    nodeLocation: "string",
    nodes: [{
        instanceType: "string",
        name: "string",
        region: "string",
        availabilityZone: "string",
        volumeIops: 0,
        volumeSize: 0,
        volumeType: "string",
    }],
    regions: ["string"],
    backupStoreIds: ["string"],
    capacity: 0,
    firewallRules: [{
        name: "string",
        port: 0,
        sources: ["string"],
    }],
    name: "string",
    resourceTags: {
        string: "string",
    },
    sshKeyId: "string",
});

    type: pgedge:Cluster
properties:
    backupStoreIds:
        - string
    capacity: 0
    cloudAccountId: string
    firewallRules:
        - name: string
          port: 0
          sources:
            - string
    name: string
    networks:
        - cidr: string
          external: false
          externalId: string
          name: string
          privateSubnets:
            - string
          publicSubnets:
            - string
          region: string
    nodeLocation: string
    nodes:
        - availabilityZone: string
          instanceType: string
          name: string
          region: string
          volumeIops: 0
          volumeSize: 0
          volumeType: string
    regions:
        - string
    resourceTags:
        string: string
    sshKeyId: string

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

    CloudAccountId string
    Networks List<Pgedge.Pgedge.Inputs.ClusterNetwork>
    NodeLocation string
    Node location of the cluster. Must be either 'public' or 'private'.
    Nodes List<Pgedge.Pgedge.Inputs.ClusterNode>
    Regions List<string>
    BackupStoreIds List<string>
    List of backup store IDs to associate with the cluster
    Capacity int
    FirewallRules List<Pgedge.Pgedge.Inputs.ClusterFirewallRule>
    Name string
    ResourceTags Dictionary<string, string>
    A map of tags to assign to the cluster
    SshKeyId string
    CloudAccountId string
    Networks []ClusterNetworkArgs
    NodeLocation string
    Node location of the cluster. Must be either 'public' or 'private'.
    Nodes []ClusterNodeArgs
    Regions []string
    BackupStoreIds []string
    List of backup store IDs to associate with the cluster
    Capacity int
    FirewallRules []ClusterFirewallRuleArgs
    Name string
    ResourceTags map[string]string
    A map of tags to assign to the cluster
    SshKeyId string
    cloudAccountId String
    networks List<ClusterNetwork>
    nodeLocation String
    Node location of the cluster. Must be either 'public' or 'private'.
    nodes List<ClusterNode>
    regions List<String>
    backupStoreIds List<String>
    List of backup store IDs to associate with the cluster
    capacity Integer
    firewallRules List<ClusterFirewallRule>
    name String
    resourceTags Map<String,String>
    A map of tags to assign to the cluster
    sshKeyId String
    cloudAccountId string
    networks ClusterNetwork[]
    nodeLocation string
    Node location of the cluster. Must be either 'public' or 'private'.
    nodes ClusterNode[]
    regions string[]
    backupStoreIds string[]
    List of backup store IDs to associate with the cluster
    capacity number
    firewallRules ClusterFirewallRule[]
    name string
    resourceTags {[key: string]: string}
    A map of tags to assign to the cluster
    sshKeyId string
    cloud_account_id str
    networks Sequence[ClusterNetworkArgs]
    node_location str
    Node location of the cluster. Must be either 'public' or 'private'.
    nodes Sequence[ClusterNodeArgs]
    regions Sequence[str]
    backup_store_ids Sequence[str]
    List of backup store IDs to associate with the cluster
    capacity int
    firewall_rules Sequence[ClusterFirewallRuleArgs]
    name str
    resource_tags Mapping[str, str]
    A map of tags to assign to the cluster
    ssh_key_id str
    cloudAccountId String
    networks List<Property Map>
    nodeLocation String
    Node location of the cluster. Must be either 'public' or 'private'.
    nodes List<Property Map>
    regions List<String>
    backupStoreIds List<String>
    List of backup store IDs to associate with the cluster
    capacity Number
    firewallRules List<Property Map>
    name String
    resourceTags Map<String>
    A map of tags to assign to the cluster
    sshKeyId String

    Outputs

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

    CreatedAt string
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    CreatedAt string
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    createdAt String
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    createdAt string
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    created_at str
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    createdAt String
    id String
    The provider-assigned unique ID for this managed resource.
    status String

    Look up Existing Cluster Resource

    Get an existing Cluster 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?: ClusterState, opts?: CustomResourceOptions): Cluster
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backup_store_ids: Optional[Sequence[str]] = None,
        capacity: Optional[int] = None,
        cloud_account_id: Optional[str] = None,
        created_at: Optional[str] = None,
        firewall_rules: Optional[Sequence[ClusterFirewallRuleArgs]] = None,
        name: Optional[str] = None,
        networks: Optional[Sequence[ClusterNetworkArgs]] = None,
        node_location: Optional[str] = None,
        nodes: Optional[Sequence[ClusterNodeArgs]] = None,
        regions: Optional[Sequence[str]] = None,
        resource_tags: Optional[Mapping[str, str]] = None,
        ssh_key_id: Optional[str] = None,
        status: Optional[str] = None) -> Cluster
    func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
    public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
    public static Cluster get(String name, Output<String> id, ClusterState 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:
    BackupStoreIds List<string>
    List of backup store IDs to associate with the cluster
    Capacity int
    CloudAccountId string
    CreatedAt string
    FirewallRules List<Pgedge.Pgedge.Inputs.ClusterFirewallRule>
    Name string
    Networks List<Pgedge.Pgedge.Inputs.ClusterNetwork>
    NodeLocation string
    Node location of the cluster. Must be either 'public' or 'private'.
    Nodes List<Pgedge.Pgedge.Inputs.ClusterNode>
    Regions List<string>
    ResourceTags Dictionary<string, string>
    A map of tags to assign to the cluster
    SshKeyId string
    Status string
    BackupStoreIds []string
    List of backup store IDs to associate with the cluster
    Capacity int
    CloudAccountId string
    CreatedAt string
    FirewallRules []ClusterFirewallRuleArgs
    Name string
    Networks []ClusterNetworkArgs
    NodeLocation string
    Node location of the cluster. Must be either 'public' or 'private'.
    Nodes []ClusterNodeArgs
    Regions []string
    ResourceTags map[string]string
    A map of tags to assign to the cluster
    SshKeyId string
    Status string
    backupStoreIds List<String>
    List of backup store IDs to associate with the cluster
    capacity Integer
    cloudAccountId String
    createdAt String
    firewallRules List<ClusterFirewallRule>
    name String
    networks List<ClusterNetwork>
    nodeLocation String
    Node location of the cluster. Must be either 'public' or 'private'.
    nodes List<ClusterNode>
    regions List<String>
    resourceTags Map<String,String>
    A map of tags to assign to the cluster
    sshKeyId String
    status String
    backupStoreIds string[]
    List of backup store IDs to associate with the cluster
    capacity number
    cloudAccountId string
    createdAt string
    firewallRules ClusterFirewallRule[]
    name string
    networks ClusterNetwork[]
    nodeLocation string
    Node location of the cluster. Must be either 'public' or 'private'.
    nodes ClusterNode[]
    regions string[]
    resourceTags {[key: string]: string}
    A map of tags to assign to the cluster
    sshKeyId string
    status string
    backup_store_ids Sequence[str]
    List of backup store IDs to associate with the cluster
    capacity int
    cloud_account_id str
    created_at str
    firewall_rules Sequence[ClusterFirewallRuleArgs]
    name str
    networks Sequence[ClusterNetworkArgs]
    node_location str
    Node location of the cluster. Must be either 'public' or 'private'.
    nodes Sequence[ClusterNodeArgs]
    regions Sequence[str]
    resource_tags Mapping[str, str]
    A map of tags to assign to the cluster
    ssh_key_id str
    status str
    backupStoreIds List<String>
    List of backup store IDs to associate with the cluster
    capacity Number
    cloudAccountId String
    createdAt String
    firewallRules List<Property Map>
    name String
    networks List<Property Map>
    nodeLocation String
    Node location of the cluster. Must be either 'public' or 'private'.
    nodes List<Property Map>
    regions List<String>
    resourceTags Map<String>
    A map of tags to assign to the cluster
    sshKeyId String
    status String

    Supporting Types

    ClusterFirewallRule, ClusterFirewallRuleArgs

    Name string
    Port int
    Sources List<string>
    Name string
    Port int
    Sources []string
    name String
    port Integer
    sources List<String>
    name string
    port number
    sources string[]
    name str
    port int
    sources Sequence[str]
    name String
    port Number
    sources List<String>

    ClusterNetwork, ClusterNetworkArgs

    Cidr string
    CIDR of the network
    PublicSubnets List<string>
    List of public subnets
    Region string
    Region of the network
    External bool
    Whether the network is external
    ExternalId string
    External ID of the network
    Name string
    Name of the network
    PrivateSubnets List<string>
    List of private subnets
    Cidr string
    CIDR of the network
    PublicSubnets []string
    List of public subnets
    Region string
    Region of the network
    External bool
    Whether the network is external
    ExternalId string
    External ID of the network
    Name string
    Name of the network
    PrivateSubnets []string
    List of private subnets
    cidr String
    CIDR of the network
    publicSubnets List<String>
    List of public subnets
    region String
    Region of the network
    external Boolean
    Whether the network is external
    externalId String
    External ID of the network
    name String
    Name of the network
    privateSubnets List<String>
    List of private subnets
    cidr string
    CIDR of the network
    publicSubnets string[]
    List of public subnets
    region string
    Region of the network
    external boolean
    Whether the network is external
    externalId string
    External ID of the network
    name string
    Name of the network
    privateSubnets string[]
    List of private subnets
    cidr str
    CIDR of the network
    public_subnets Sequence[str]
    List of public subnets
    region str
    Region of the network
    external bool
    Whether the network is external
    external_id str
    External ID of the network
    name str
    Name of the network
    private_subnets Sequence[str]
    List of private subnets
    cidr String
    CIDR of the network
    publicSubnets List<String>
    List of public subnets
    region String
    Region of the network
    external Boolean
    Whether the network is external
    externalId String
    External ID of the network
    name String
    Name of the network
    privateSubnets List<String>
    List of private subnets

    ClusterNode, ClusterNodeArgs

    instanceType String
    name String
    region String
    availabilityZone String
    volumeIops Integer
    volumeSize Integer
    volumeType String
    instanceType string
    name string
    region string
    availabilityZone string
    volumeIops number
    volumeSize number
    volumeType string
    instanceType String
    name String
    region String
    availabilityZone String
    volumeIops Number
    volumeSize Number
    volumeType String

    Package Details

    Repository
    pgedge pgEdge/pulumi-pgedge
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the pgedge Terraform Provider.
    pgedge logo
    pgEdge v0.0.40 published on Friday, Jan 10, 2025 by pgEdge
    pgEdge/pulumi-pgedge