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

constellix.CnameRecordPool

Explore with Pulumi AI

Create CnameRecordPool Resource

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

Constructor syntax

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

@overload
def CnameRecordPool(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    min_available_failover: Optional[float] = None,
                    num_return: Optional[float] = None,
                    values: Optional[Sequence[CnameRecordPoolValueArgs]] = None,
                    cname_record_pool_id: Optional[str] = None,
                    disable_flag: Optional[str] = None,
                    failed_flag: Optional[str] = None,
                    name: Optional[str] = None,
                    note: Optional[str] = None,
                    version: Optional[float] = None)
func NewCnameRecordPool(ctx *Context, name string, args CnameRecordPoolArgs, opts ...ResourceOption) (*CnameRecordPool, error)
public CnameRecordPool(string name, CnameRecordPoolArgs args, CustomResourceOptions? opts = null)
public CnameRecordPool(String name, CnameRecordPoolArgs args)
public CnameRecordPool(String name, CnameRecordPoolArgs args, CustomResourceOptions options)
type: constellix:CnameRecordPool
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. CnameRecordPoolArgs
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. CnameRecordPoolArgs
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. CnameRecordPoolArgs
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. CnameRecordPoolArgs
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. CnameRecordPoolArgs
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 cnameRecordPoolResource = new Constellix.CnameRecordPool("cnameRecordPoolResource", new()
{
    MinAvailableFailover = 0,
    NumReturn = 0,
    Values = new[]
    {
        new Constellix.Inputs.CnameRecordPoolValueArgs
        {
            Policy = "string",
            Value = "string",
            Weight = 0,
            CheckId = 0,
            DisableFlag = "string",
        },
    },
    CnameRecordPoolId = "string",
    DisableFlag = "string",
    FailedFlag = "string",
    Name = "string",
    Note = "string",
    Version = 0,
});
Copy
example, err := constellix.NewCnameRecordPool(ctx, "cnameRecordPoolResource", &constellix.CnameRecordPoolArgs{
MinAvailableFailover: pulumi.Float64(0),
NumReturn: pulumi.Float64(0),
Values: .CnameRecordPoolValueArray{
&.CnameRecordPoolValueArgs{
Policy: pulumi.String("string"),
Value: pulumi.String("string"),
Weight: pulumi.Float64(0),
CheckId: pulumi.Float64(0),
DisableFlag: pulumi.String("string"),
},
},
CnameRecordPoolId: pulumi.String("string"),
DisableFlag: pulumi.String("string"),
FailedFlag: pulumi.String("string"),
Name: pulumi.String("string"),
Note: pulumi.String("string"),
Version: pulumi.Float64(0),
})
Copy
var cnameRecordPoolResource = new CnameRecordPool("cnameRecordPoolResource", CnameRecordPoolArgs.builder()
    .minAvailableFailover(0)
    .numReturn(0)
    .values(CnameRecordPoolValueArgs.builder()
        .policy("string")
        .value("string")
        .weight(0)
        .checkId(0)
        .disableFlag("string")
        .build())
    .cnameRecordPoolId("string")
    .disableFlag("string")
    .failedFlag("string")
    .name("string")
    .note("string")
    .version(0)
    .build());
Copy
cname_record_pool_resource = constellix.CnameRecordPool("cnameRecordPoolResource",
    min_available_failover=0,
    num_return=0,
    values=[{
        "policy": "string",
        "value": "string",
        "weight": 0,
        "check_id": 0,
        "disable_flag": "string",
    }],
    cname_record_pool_id="string",
    disable_flag="string",
    failed_flag="string",
    name="string",
    note="string",
    version=0)
Copy
const cnameRecordPoolResource = new constellix.CnameRecordPool("cnameRecordPoolResource", {
    minAvailableFailover: 0,
    numReturn: 0,
    values: [{
        policy: "string",
        value: "string",
        weight: 0,
        checkId: 0,
        disableFlag: "string",
    }],
    cnameRecordPoolId: "string",
    disableFlag: "string",
    failedFlag: "string",
    name: "string",
    note: "string",
    version: 0,
});
Copy
type: constellix:CnameRecordPool
properties:
    cnameRecordPoolId: string
    disableFlag: string
    failedFlag: string
    minAvailableFailover: 0
    name: string
    note: string
    numReturn: 0
    values:
        - checkId: 0
          disableFlag: string
          policy: string
          value: string
          weight: 0
    version: 0
Copy

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

MinAvailableFailover This property is required. double
NumReturn This property is required. double
Values This property is required. List<CnameRecordPoolValue>
CnameRecordPoolId string
The constellix calculated id of the cname record pool resource.
DisableFlag string
FailedFlag string
Name string
Note string
Version double
MinAvailableFailover This property is required. float64
NumReturn This property is required. float64
Values This property is required. []CnameRecordPoolValueArgs
CnameRecordPoolId string
The constellix calculated id of the cname record pool resource.
DisableFlag string
FailedFlag string
Name string
Note string
Version float64
minAvailableFailover This property is required. Double
numReturn This property is required. Double
values This property is required. List<CnameRecordPoolValue>
cnameRecordPoolId String
The constellix calculated id of the cname record pool resource.
disableFlag String
failedFlag String
name String
note String
version Double
minAvailableFailover This property is required. number
numReturn This property is required. number
values This property is required. CnameRecordPoolValue[]
cnameRecordPoolId string
The constellix calculated id of the cname record pool resource.
disableFlag string
failedFlag string
name string
note string
version number
min_available_failover This property is required. float
num_return This property is required. float
values This property is required. Sequence[CnameRecordPoolValueArgs]
cname_record_pool_id str
The constellix calculated id of the cname record pool resource.
disable_flag str
failed_flag str
name str
note str
version float
minAvailableFailover This property is required. Number
numReturn This property is required. Number
values This property is required. List<Property Map>
cnameRecordPoolId String
The constellix calculated id of the cname record pool resource.
disableFlag String
failedFlag String
name String
note String
version Number

Outputs

All input properties are implicitly available as output properties. Additionally, the CnameRecordPool 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 CnameRecordPool Resource

Get an existing CnameRecordPool 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?: CnameRecordPoolState, opts?: CustomResourceOptions): CnameRecordPool
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cname_record_pool_id: Optional[str] = None,
        disable_flag: Optional[str] = None,
        failed_flag: 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[CnameRecordPoolValueArgs]] = None,
        version: Optional[float] = None) -> CnameRecordPool
func GetCnameRecordPool(ctx *Context, name string, id IDInput, state *CnameRecordPoolState, opts ...ResourceOption) (*CnameRecordPool, error)
public static CnameRecordPool Get(string name, Input<string> id, CnameRecordPoolState? state, CustomResourceOptions? opts = null)
public static CnameRecordPool get(String name, Output<String> id, CnameRecordPoolState state, CustomResourceOptions options)
resources:  _:    type: constellix:CnameRecordPool    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:
CnameRecordPoolId string
The constellix calculated id of the cname record pool resource.
DisableFlag string
FailedFlag string
MinAvailableFailover double
Name string
Note string
NumReturn double
Values List<CnameRecordPoolValue>
Version double
CnameRecordPoolId string
The constellix calculated id of the cname record pool resource.
DisableFlag string
FailedFlag string
MinAvailableFailover float64
Name string
Note string
NumReturn float64
Values []CnameRecordPoolValueArgs
Version float64
cnameRecordPoolId String
The constellix calculated id of the cname record pool resource.
disableFlag String
failedFlag String
minAvailableFailover Double
name String
note String
numReturn Double
values List<CnameRecordPoolValue>
version Double
cnameRecordPoolId string
The constellix calculated id of the cname record pool resource.
disableFlag string
failedFlag string
minAvailableFailover number
name string
note string
numReturn number
values CnameRecordPoolValue[]
version number
cname_record_pool_id str
The constellix calculated id of the cname record pool resource.
disable_flag str
failed_flag str
min_available_failover float
name str
note str
num_return float
values Sequence[CnameRecordPoolValueArgs]
version float
cnameRecordPoolId String
The constellix calculated id of the cname record pool resource.
disableFlag String
failedFlag String
minAvailableFailover Number
name String
note String
numReturn Number
values List<Property Map>
version Number

Supporting Types

CnameRecordPoolValue
, CnameRecordPoolValueArgs

Policy This property is required. string
Value This property is required. string
Weight This property is required. double
CheckId double
DisableFlag string
Policy This property is required. string
Value This property is required. string
Weight This property is required. float64
CheckId float64
DisableFlag string
policy This property is required. String
value This property is required. String
weight This property is required. Double
checkId Double
disableFlag String
policy This property is required. string
value This property is required. string
weight This property is required. number
checkId number
disableFlag string
policy This property is required. str
value This property is required. str
weight This property is required. float
check_id float
disable_flag str
policy This property is required. String
value This property is required. String
weight This property is required. Number
checkId Number
disableFlag String

Package Details

Repository
constellix constellix/terraform-provider-constellix
License
Notes
This Pulumi package is based on the constellix Terraform Provider.