Record

Create a Record Resource

new Record(name: string, args: RecordArgs, opts?: CustomResourceOptions);

def Record(resource_name, opts=None, data=None, name=None, priority=None, proxied=None, ttl=None, type=None, value=None, zone_id=None, __props__=None);

func NewRecord(ctx *Context, name string, args RecordArgs, opts ...ResourceOption) (*Record, error)

public Record(string name, RecordArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args RecordArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args RecordArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RecordArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Record Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Record resource accepts the following input properties:

Name string: The name of the record
Type string: The type of the record
ZoneId string: The DNS zone ID to add the record to
Data RecordDataArgs: Map of attributes that constitute the record value. Primarily used for LOC and SRV record types. Either this or value must be specified
Priority int: The priority of the record
Proxied bool: Whether the record gets Cloudflare’s origin protection; defaults to false.
Ttl int: The TTL of the record (automatic: ‘1’)
Value string: The (string) value of the record. Either this or data must be specified

Name string: The name of the record
Type string: The type of the record
ZoneId string: The DNS zone ID to add the record to
Data RecordData: Map of attributes that constitute the record value. Primarily used for LOC and SRV record types. Either this or value must be specified
Priority int: The priority of the record
Proxied bool: Whether the record gets Cloudflare’s origin protection; defaults to false.
Ttl int: The TTL of the record (automatic: ‘1’)
Value string: The (string) value of the record. Either this or data must be specified

name string: The name of the record
type string: The type of the record
zoneId string: The DNS zone ID to add the record to
data RecordData: Map of attributes that constitute the record value. Primarily used for LOC and SRV record types. Either this or value must be specified
priority number: The priority of the record
proxied boolean: Whether the record gets Cloudflare’s origin protection; defaults to false.
ttl number: The TTL of the record (automatic: ‘1’)
value string: The (string) value of the record. Either this or data must be specified

name str: The name of the record
type str: The type of the record
zone_id str: The DNS zone ID to add the record to
data Dict[RecordData]: Map of attributes that constitute the record value. Primarily used for LOC and SRV record types. Either this or value must be specified
priority float: The priority of the record
proxied bool: Whether the record gets Cloudflare’s origin protection; defaults to false.
ttl float: The TTL of the record (automatic: ‘1’)
value str: The (string) value of the record. Either this or data must be specified

Outputs

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

CreatedOn string: The RFC3339 timestamp of when the record was created
Hostname string: The FQDN of the record
Id string: The provider-assigned unique ID for this managed resource.
Metadata Dictionary<string, object>: A key-value map of string metadata Cloudflare associates with the record
ModifiedOn string: The RFC3339 timestamp of when the record was last modified
Proxiable bool: Shows whether this record can be proxied, must be true if setting proxied=true

CreatedOn string: The RFC3339 timestamp of when the record was created
Hostname string: The FQDN of the record
Id string: The provider-assigned unique ID for this managed resource.
Metadata map[string]interface{}: A key-value map of string metadata Cloudflare associates with the record
ModifiedOn string: The RFC3339 timestamp of when the record was last modified
Proxiable bool: Shows whether this record can be proxied, must be true if setting proxied=true

createdOn string: The RFC3339 timestamp of when the record was created
hostname string: The FQDN of the record
id string: The provider-assigned unique ID for this managed resource.
metadata {[key: string]: any}: A key-value map of string metadata Cloudflare associates with the record
modifiedOn string: The RFC3339 timestamp of when the record was last modified
proxiable boolean: Shows whether this record can be proxied, must be true if setting proxied=true

created_on str: The RFC3339 timestamp of when the record was created
hostname str: The FQDN of the record
id str: The provider-assigned unique ID for this managed resource.
metadata Dict[str, Any]: A key-value map of string metadata Cloudflare associates with the record
modified_on str: The RFC3339 timestamp of when the record was last modified
proxiable bool: Shows whether this record can be proxied, must be true if setting proxied=true

Look up an Existing Record Resource

Get an existing Record 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?: RecordState, opts?: CustomResourceOptions): Record

static get(resource_name, id, opts=None, created_on=None, data=None, hostname=None, metadata=None, modified_on=None, name=None, priority=None, proxiable=None, proxied=None, ttl=None, type=None, value=None, zone_id=None, __props__=None);

func GetRecord(ctx *Context, name string, id IDInput, state *RecordState, opts ...ResourceOption) (*Record, error)

public static Record Get(string name, Input<string> id, RecordState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

CreatedOn string: The RFC3339 timestamp of when the record was created
Data RecordDataArgs: Map of attributes that constitute the record value. Primarily used for LOC and SRV record types. Either this or value must be specified
Hostname string: The FQDN of the record
Metadata Dictionary<string, object>: A key-value map of string metadata Cloudflare associates with the record
ModifiedOn string: The RFC3339 timestamp of when the record was last modified
Name string: The name of the record
Priority int: The priority of the record
Proxiable bool: Shows whether this record can be proxied, must be true if setting proxied=true
Proxied bool: Whether the record gets Cloudflare’s origin protection; defaults to false.
Ttl int: The TTL of the record (automatic: ‘1’)
Type string: The type of the record
Value string: The (string) value of the record. Either this or data must be specified
ZoneId string: The DNS zone ID to add the record to

CreatedOn string: The RFC3339 timestamp of when the record was created
Data RecordData: Map of attributes that constitute the record value. Primarily used for LOC and SRV record types. Either this or value must be specified
Hostname string: The FQDN of the record
Metadata map[string]interface{}: A key-value map of string metadata Cloudflare associates with the record
ModifiedOn string: The RFC3339 timestamp of when the record was last modified
Name string: The name of the record
Priority int: The priority of the record
Proxiable bool: Shows whether this record can be proxied, must be true if setting proxied=true
Proxied bool: Whether the record gets Cloudflare’s origin protection; defaults to false.
Ttl int: The TTL of the record (automatic: ‘1’)
Type string: The type of the record
Value string: The (string) value of the record. Either this or data must be specified
ZoneId string: The DNS zone ID to add the record to

createdOn string: The RFC3339 timestamp of when the record was created
data RecordData: Map of attributes that constitute the record value. Primarily used for LOC and SRV record types. Either this or value must be specified
hostname string: The FQDN of the record
metadata {[key: string]: any}: A key-value map of string metadata Cloudflare associates with the record
modifiedOn string: The RFC3339 timestamp of when the record was last modified
name string: The name of the record
priority number: The priority of the record
proxiable boolean: Shows whether this record can be proxied, must be true if setting proxied=true
proxied boolean: Whether the record gets Cloudflare’s origin protection; defaults to false.
ttl number: The TTL of the record (automatic: ‘1’)
type string: The type of the record
value string: The (string) value of the record. Either this or data must be specified
zoneId string: The DNS zone ID to add the record to

created_on str: The RFC3339 timestamp of when the record was created
data Dict[RecordData]: Map of attributes that constitute the record value. Primarily used for LOC and SRV record types. Either this or value must be specified
hostname str: The FQDN of the record
metadata Dict[str, Any]: A key-value map of string metadata Cloudflare associates with the record
modified_on str: The RFC3339 timestamp of when the record was last modified
name str: The name of the record
priority float: The priority of the record
proxiable bool: Shows whether this record can be proxied, must be true if setting proxied=true
proxied bool: Whether the record gets Cloudflare’s origin protection; defaults to false.
ttl float: The TTL of the record (automatic: ‘1’)
type str: The type of the record
value str: The (string) value of the record. Either this or data must be specified
zone_id str: The DNS zone ID to add the record to