Cloudflare v5.0.0, Mar 13 23

cloudflare.Web3Hostname

Manages Web3 hostnames for IPFS and Ethereum gateways.

Create Web3Hostname Resource

new Web3Hostname(name: string, args: Web3HostnameArgs, opts?: CustomResourceOptions);

@overload
def Web3Hostname(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 description: Optional[str] = None,
                 dnslink: Optional[str] = None,
                 name: Optional[str] = None,
                 target: Optional[str] = None,
                 zone_id: Optional[str] = None)
@overload
def Web3Hostname(resource_name: str,
                 args: Web3HostnameArgs,
                 opts: Optional[ResourceOptions] = None)

func NewWeb3Hostname(ctx *Context, name string, args Web3HostnameArgs, opts ...ResourceOption) (*Web3Hostname, error)

public Web3Hostname(string name, Web3HostnameArgs args, CustomResourceOptions? opts = null)

public Web3Hostname(String name, Web3HostnameArgs args)
public Web3Hostname(String name, Web3HostnameArgs args, CustomResourceOptions options)

type: cloudflare:Web3Hostname
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args Web3HostnameArgs: 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 Web3HostnameArgs: 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 Web3HostnameArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args Web3HostnameArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

Name string: The hostname that will point to the target gateway via CNAME.
Target string: Target gateway of the hostname.
ZoneId string: The zone identifier to target for the resource.
Description string: An optional description of the hostname.
Dnslink string: DNSLink value used if the target is ipfs.

Name string: The hostname that will point to the target gateway via CNAME.
Target string: Target gateway of the hostname.
ZoneId string: The zone identifier to target for the resource.
Description string: An optional description of the hostname.
Dnslink string: DNSLink value used if the target is ipfs.

name String: The hostname that will point to the target gateway via CNAME.
target String: Target gateway of the hostname.
zoneId String: The zone identifier to target for the resource.
description String: An optional description of the hostname.
dnslink String: DNSLink value used if the target is ipfs.

name string: The hostname that will point to the target gateway via CNAME.
target string: Target gateway of the hostname.
zoneId string: The zone identifier to target for the resource.
description string: An optional description of the hostname.
dnslink string: DNSLink value used if the target is ipfs.

name str: The hostname that will point to the target gateway via CNAME.
target str: Target gateway of the hostname.
zone_id str: The zone identifier to target for the resource.
description str: An optional description of the hostname.
dnslink str: DNSLink value used if the target is ipfs.

name String: The hostname that will point to the target gateway via CNAME.
target String: Target gateway of the hostname.
zoneId String: The zone identifier to target for the resource.
description String: An optional description of the hostname.
dnslink String: DNSLink value used if the target is ipfs.

Outputs

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

CreatedOn string: Creation time.
Id string: The provider-assigned unique ID for this managed resource.
ModifiedOn string: Last modification time.
Status string: Status of the hostname's activation.

CreatedOn string: Creation time.
Id string: The provider-assigned unique ID for this managed resource.
ModifiedOn string: Last modification time.
Status string: Status of the hostname's activation.

createdOn String: Creation time.
id String: The provider-assigned unique ID for this managed resource.
modifiedOn String: Last modification time.
status String: Status of the hostname's activation.

createdOn string: Creation time.
id string: The provider-assigned unique ID for this managed resource.
modifiedOn string: Last modification time.
status string: Status of the hostname's activation.

created_on str: Creation time.
id str: The provider-assigned unique ID for this managed resource.
modified_on str: Last modification time.
status str: Status of the hostname's activation.

createdOn String: Creation time.
id String: The provider-assigned unique ID for this managed resource.
modifiedOn String: Last modification time.
status String: Status of the hostname's activation.

Look up Existing Web3Hostname Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_on: Optional[str] = None,
        description: Optional[str] = None,
        dnslink: Optional[str] = None,
        modified_on: Optional[str] = None,
        name: Optional[str] = None,
        status: Optional[str] = None,
        target: Optional[str] = None,
        zone_id: Optional[str] = None) -> Web3Hostname

func GetWeb3Hostname(ctx *Context, name string, id IDInput, state *Web3HostnameState, opts ...ResourceOption) (*Web3Hostname, error)

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

public static Web3Hostname get(String name, Output<String> id, Web3HostnameState 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:

CreatedOn string: Creation time.
Description string: An optional description of the hostname.
Dnslink string: DNSLink value used if the target is ipfs.
ModifiedOn string: Last modification time.
Name string: The hostname that will point to the target gateway via CNAME.
Status string: Status of the hostname's activation.
Target string: Target gateway of the hostname.
ZoneId string: The zone identifier to target for the resource.

CreatedOn string: Creation time.
Description string: An optional description of the hostname.
Dnslink string: DNSLink value used if the target is ipfs.
ModifiedOn string: Last modification time.
Name string: The hostname that will point to the target gateway via CNAME.
Status string: Status of the hostname's activation.
Target string: Target gateway of the hostname.
ZoneId string: The zone identifier to target for the resource.

createdOn String: Creation time.
description String: An optional description of the hostname.
dnslink String: DNSLink value used if the target is ipfs.
modifiedOn String: Last modification time.
name String: The hostname that will point to the target gateway via CNAME.
status String: Status of the hostname's activation.
target String: Target gateway of the hostname.
zoneId String: The zone identifier to target for the resource.

createdOn string: Creation time.
description string: An optional description of the hostname.
dnslink string: DNSLink value used if the target is ipfs.
modifiedOn string: Last modification time.
name string: The hostname that will point to the target gateway via CNAME.
status string: Status of the hostname's activation.
target string: Target gateway of the hostname.
zoneId string: The zone identifier to target for the resource.

created_on str: Creation time.
description str: An optional description of the hostname.
dnslink str: DNSLink value used if the target is ipfs.
modified_on str: Last modification time.
name str: The hostname that will point to the target gateway via CNAME.
status str: Status of the hostname's activation.
target str: Target gateway of the hostname.
zone_id str: The zone identifier to target for the resource.

createdOn String: Creation time.
description String: An optional description of the hostname.
dnslink String: DNSLink value used if the target is ipfs.
modifiedOn String: Last modification time.
name String: The hostname that will point to the target gateway via CNAME.
status String: Status of the hostname's activation.
target String: Target gateway of the hostname.
zoneId String: The zone identifier to target for the resource.

Package Details

Repository: Cloudflare pulumi/pulumi-cloudflare
License: Apache-2.0
Notes: This Pulumi package is based on the cloudflare Terraform Provider.