1. Packages
  2. Constellix Provider
  3. API Docs
  4. getCnameRecordPool
constellix 0.4.6 published on Friday, Mar 7, 2025 by constellix

constellix.getCnameRecordPool

Explore with Pulumi AI

constellix logo
constellix 0.4.6 published on Friday, Mar 7, 2025 by constellix

    Data source for the pools of CNAME records.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as constellix from "@pulumi/constellix";
    
    const prac = constellix.getCnameRecordPool({
        name: "firstrecord",
    });
    
    import pulumi
    import pulumi_constellix as constellix
    
    prac = constellix.get_cname_record_pool(name="firstrecord")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/constellix/constellix"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := constellix.LookupCnameRecordPool(ctx, &constellix.LookupCnameRecordPoolArgs{
    			Name: "firstrecord",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Constellix = Pulumi.Constellix;
    
    return await Deployment.RunAsync(() => 
    {
        var prac = Constellix.GetCnameRecordPool.Invoke(new()
        {
            Name = "firstrecord",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.constellix.ConstellixFunctions;
    import com.pulumi.constellix.inputs.GetCnameRecordPoolArgs;
    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) {
            final var prac = ConstellixFunctions.getCnameRecordPool(GetCnameRecordPoolArgs.builder()
                .name("firstrecord")
                .build());
    
        }
    }
    
    variables:
      prac:
        fn::invoke:
          function: constellix:getCnameRecordPool
          arguments:
            name: firstrecord
    

    Attribute Reference

    • num_return - (Optional) minimum number of value object to return. Value must be in between 0 and 64.
    • min_available_failover - (Optional) minimum number of Available Failover . Value must be in between 0 and 64.
    • version - (Optional) System generated version number.
    • failed_flag - (Optional) failed flag. Default is false.
    • disable_flag1 - (Optional) Enable or disable pool values. Default is false.
    • values - (Optional) Object Number of IP/Hosts in a pool values cannot be less than the “Num Return” and “Min Available” values
    • values.value - (Optional) Host name. If “Host” value does not end in a dot, your domain name will be appended to it.
    • values.weight - (Optional)weight number to sort the priorty. Weight must be in between 1 and 1000000
    • values.disable_flag - (Optional) Enable or disable pool values. Default is false.
    • values.check_id - (Optional) Sonar check id is Optional when you want to apply the ITO feature on a pool.
    • values.policy - (Optional) “followsonar” for Follow sonar. “alwaysoff” for Always off. “alwayson” for Always on. “offonfailure” for Off on Failure.
    • note - (Optional) Description.

    Using getCnameRecordPool

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCnameRecordPool(args: GetCnameRecordPoolArgs, opts?: InvokeOptions): Promise<GetCnameRecordPoolResult>
    function getCnameRecordPoolOutput(args: GetCnameRecordPoolOutputArgs, opts?: InvokeOptions): Output<GetCnameRecordPoolResult>
    def get_cname_record_pool(disableflag1: Optional[bool] = None,
                              failed_flag: Optional[bool] = None,
                              id: Optional[str] = None,
                              min_available_failover: Optional[float] = None,
                              name: Optional[str] = None,
                              note: Optional[str] = None,
                              num_return: Optional[float] = None,
                              values: Optional[Sequence[GetCnameRecordPoolValue]] = None,
                              version: Optional[float] = None,
                              opts: Optional[InvokeOptions] = None) -> GetCnameRecordPoolResult
    def get_cname_record_pool_output(disableflag1: Optional[pulumi.Input[bool]] = None,
                              failed_flag: Optional[pulumi.Input[bool]] = None,
                              id: Optional[pulumi.Input[str]] = None,
                              min_available_failover: Optional[pulumi.Input[float]] = None,
                              name: Optional[pulumi.Input[str]] = None,
                              note: Optional[pulumi.Input[str]] = None,
                              num_return: Optional[pulumi.Input[float]] = None,
                              values: Optional[pulumi.Input[Sequence[pulumi.Input[GetCnameRecordPoolValueArgs]]]] = None,
                              version: Optional[pulumi.Input[float]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetCnameRecordPoolResult]
    func LookupCnameRecordPool(ctx *Context, args *LookupCnameRecordPoolArgs, opts ...InvokeOption) (*LookupCnameRecordPoolResult, error)
    func LookupCnameRecordPoolOutput(ctx *Context, args *LookupCnameRecordPoolOutputArgs, opts ...InvokeOption) LookupCnameRecordPoolResultOutput

    > Note: This function is named LookupCnameRecordPool in the Go SDK.

    public static class GetCnameRecordPool 
    {
        public static Task<GetCnameRecordPoolResult> InvokeAsync(GetCnameRecordPoolArgs args, InvokeOptions? opts = null)
        public static Output<GetCnameRecordPoolResult> Invoke(GetCnameRecordPoolInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCnameRecordPoolResult> getCnameRecordPool(GetCnameRecordPoolArgs args, InvokeOptions options)
    public static Output<GetCnameRecordPoolResult> getCnameRecordPool(GetCnameRecordPoolArgs args, InvokeOptions options)
    
    fn::invoke:
      function: constellix:index/getCnameRecordPool:getCnameRecordPool
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Pool name should be unique.
    Disableflag1 bool
    FailedFlag bool
    Id string
    MinAvailableFailover double
    Note string
    NumReturn double
    Values List<GetCnameRecordPoolValue>
    Version double
    Name string
    Pool name should be unique.
    Disableflag1 bool
    FailedFlag bool
    Id string
    MinAvailableFailover float64
    Note string
    NumReturn float64
    Values []GetCnameRecordPoolValue
    Version float64
    name String
    Pool name should be unique.
    disableflag1 Boolean
    failedFlag Boolean
    id String
    minAvailableFailover Double
    note String
    numReturn Double
    values List<GetCnameRecordPoolValue>
    version Double
    name string
    Pool name should be unique.
    disableflag1 boolean
    failedFlag boolean
    id string
    minAvailableFailover number
    note string
    numReturn number
    values GetCnameRecordPoolValue[]
    version number
    name String
    Pool name should be unique.
    disableflag1 Boolean
    failedFlag Boolean
    id String
    minAvailableFailover Number
    note String
    numReturn Number
    values List<Property Map>
    version Number

    getCnameRecordPool Result

    The following output properties are available:

    Supporting Types

    GetCnameRecordPoolValue

    CheckId double
    DisableFlag bool
    Policy string
    Value string
    Weight double
    CheckId float64
    DisableFlag bool
    Policy string
    Value string
    Weight float64
    checkId Double
    disableFlag Boolean
    policy String
    value String
    weight Double
    checkId number
    disableFlag boolean
    policy string
    value string
    weight number
    check_id float
    disable_flag bool
    policy str
    value str
    weight float
    checkId Number
    disableFlag Boolean
    policy String
    value String
    weight Number

    Package Details

    Repository
    constellix constellix/terraform-provider-constellix
    License
    Notes
    This Pulumi package is based on the constellix Terraform Provider.
    constellix logo
    constellix 0.4.6 published on Friday, Mar 7, 2025 by constellix