Get information on the requirements of a registrant change.
Note: The registrant change API is currently in developer preview and is subject to change.
Example Usage
Get registrant change requirements for the example.com domain and the contact with ID 1234:
import * as pulumi from "@pulumi/pulumi";
import * as dnsimple from "@pulumi/dnsimple";
const example = dnsimple.getRegistrantChangeCheck({
domainId: "example.com",
contactId: "1234",
});
import pulumi
import pulumi_dnsimple as dnsimple
example = dnsimple.get_registrant_change_check(domain_id="example.com",
contact_id="1234")
package main
import (
"github.com/pulumi/pulumi-dnsimple/sdk/v5/go/dnsimple"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := dnsimple.GetRegistrantChangeCheck(ctx, &dnsimple.GetRegistrantChangeCheckArgs{
DomainId: "example.com",
ContactId: "1234",
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DNSimple = Pulumi.DNSimple;
return await Deployment.RunAsync(() =>
{
var example = DNSimple.GetRegistrantChangeCheck.Invoke(new()
{
DomainId = "example.com",
ContactId = "1234",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dnsimple.DnsimpleFunctions;
import com.pulumi.dnsimple.inputs.GetRegistrantChangeCheckArgs;
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 example = DnsimpleFunctions.getRegistrantChangeCheck(GetRegistrantChangeCheckArgs.builder()
.domainId("example.com")
.contactId("1234")
.build());
}
}
variables:
example:
fn::invoke:
function: dnsimple:getRegistrantChangeCheck
arguments:
domainId: example.com
contactId: '1234'
Using getRegistrantChangeCheck
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 getRegistrantChangeCheck(args: GetRegistrantChangeCheckArgs, opts?: InvokeOptions): Promise<GetRegistrantChangeCheckResult>
function getRegistrantChangeCheckOutput(args: GetRegistrantChangeCheckOutputArgs, opts?: InvokeOptions): Output<GetRegistrantChangeCheckResult>def get_registrant_change_check(contact_id: Optional[str] = None,
domain_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetRegistrantChangeCheckResult
def get_registrant_change_check_output(contact_id: Optional[pulumi.Input[str]] = None,
domain_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetRegistrantChangeCheckResult]func GetRegistrantChangeCheck(ctx *Context, args *GetRegistrantChangeCheckArgs, opts ...InvokeOption) (*GetRegistrantChangeCheckResult, error)
func GetRegistrantChangeCheckOutput(ctx *Context, args *GetRegistrantChangeCheckOutputArgs, opts ...InvokeOption) GetRegistrantChangeCheckResultOutput> Note: This function is named GetRegistrantChangeCheck in the Go SDK.
public static class GetRegistrantChangeCheck
{
public static Task<GetRegistrantChangeCheckResult> InvokeAsync(GetRegistrantChangeCheckArgs args, InvokeOptions? opts = null)
public static Output<GetRegistrantChangeCheckResult> Invoke(GetRegistrantChangeCheckInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetRegistrantChangeCheckResult> getRegistrantChangeCheck(GetRegistrantChangeCheckArgs args, InvokeOptions options)
public static Output<GetRegistrantChangeCheckResult> getRegistrantChangeCheck(GetRegistrantChangeCheckArgs args, InvokeOptions options)
fn::invoke:
function: dnsimple:index/getRegistrantChangeCheck:getRegistrantChangeCheck
arguments:
# arguments dictionaryThe following arguments are supported:
- contact_
id str - The ID of the contact you are planning to change to.
- domain_
id str - The name or ID of the domain.
getRegistrantChangeCheck Result
The following output properties are available:
- Contact
Id string - The ID of the contact you are planning to change to.
- Domain
Id string - The name or ID of the domain.
- Extended
Attributes List<Pulumi.DNSimple. Outputs. Get Registrant Change Check Extended Attribute> - (List) A list of extended attributes that are required for the registrant change. (see below for nested schema)
- Id string
- Registry
Owner boolChange - (Boolean) Whether the registrant change is going to result in an owner change at the registry.
- Contact
Id string - The ID of the contact you are planning to change to.
- Domain
Id string - The name or ID of the domain.
- Extended
Attributes []GetRegistrant Change Check Extended Attribute - (List) A list of extended attributes that are required for the registrant change. (see below for nested schema)
- Id string
- Registry
Owner boolChange - (Boolean) Whether the registrant change is going to result in an owner change at the registry.
- contact
Id String - The ID of the contact you are planning to change to.
- domain
Id String - The name or ID of the domain.
- extended
Attributes List<GetRegistrant Change Check Extended Attribute> - (List) A list of extended attributes that are required for the registrant change. (see below for nested schema)
- id String
- registry
Owner BooleanChange - (Boolean) Whether the registrant change is going to result in an owner change at the registry.
- contact
Id string - The ID of the contact you are planning to change to.
- domain
Id string - The name or ID of the domain.
- extended
Attributes GetRegistrant Change Check Extended Attribute[] - (List) A list of extended attributes that are required for the registrant change. (see below for nested schema)
- id string
- registry
Owner booleanChange - (Boolean) Whether the registrant change is going to result in an owner change at the registry.
- contact_
id str - The ID of the contact you are planning to change to.
- domain_
id str - The name or ID of the domain.
- extended_
attributes Sequence[GetRegistrant Change Check Extended Attribute] - (List) A list of extended attributes that are required for the registrant change. (see below for nested schema)
- id str
- registry_
owner_ boolchange - (Boolean) Whether the registrant change is going to result in an owner change at the registry.
- contact
Id String - The ID of the contact you are planning to change to.
- domain
Id String - The name or ID of the domain.
- extended
Attributes List<Property Map> - (List) A list of extended attributes that are required for the registrant change. (see below for nested schema)
- id String
- registry
Owner BooleanChange - (Boolean) Whether the registrant change is going to result in an owner change at the registry.
Supporting Types
GetRegistrantChangeCheckExtendedAttribute
- Description string
- (String) - The description of the option.
- Name string
- (String) - The name of the extended attribute, e.g.,
x-au-registrant-id-type. - Options
List<Pulumi.
DNSimple. Inputs. Get Registrant Change Check Extended Attribute Option> - (List) - A list of options for the extended attribute. (see below for nested schema)
- Required bool
- (Boolean) - Whether the extended attribute is required.
- Description string
- (String) - The description of the option.
- Name string
- (String) - The name of the extended attribute, e.g.,
x-au-registrant-id-type. - Options
[]Get
Registrant Change Check Extended Attribute Option - (List) - A list of options for the extended attribute. (see below for nested schema)
- Required bool
- (Boolean) - Whether the extended attribute is required.
- description String
- (String) - The description of the option.
- name String
- (String) - The name of the extended attribute, e.g.,
x-au-registrant-id-type. - options
List<Get
Registrant Change Check Extended Attribute Option> - (List) - A list of options for the extended attribute. (see below for nested schema)
- required Boolean
- (Boolean) - Whether the extended attribute is required.
- description string
- (String) - The description of the option.
- name string
- (String) - The name of the extended attribute, e.g.,
x-au-registrant-id-type. - options
Get
Registrant Change Check Extended Attribute Option[] - (List) - A list of options for the extended attribute. (see below for nested schema)
- required boolean
- (Boolean) - Whether the extended attribute is required.
- description str
- (String) - The description of the option.
- name str
- (String) - The name of the extended attribute, e.g.,
x-au-registrant-id-type. - options
Sequence[Get
Registrant Change Check Extended Attribute Option] - (List) - A list of options for the extended attribute. (see below for nested schema)
- required bool
- (Boolean) - Whether the extended attribute is required.
- description String
- (String) - The description of the option.
- name String
- (String) - The name of the extended attribute, e.g.,
x-au-registrant-id-type. - options List<Property Map>
- (List) - A list of options for the extended attribute. (see below for nested schema)
- required Boolean
- (Boolean) - Whether the extended attribute is required.
GetRegistrantChangeCheckExtendedAttributeOption
- Description string
- (String) - The description of the option.
- Title string
- (String) - The human-readable title of the option, e.g.,
Australian Company Number (ACN). - Value string
- (String) - The value of the option.
- Description string
- (String) - The description of the option.
- Title string
- (String) - The human-readable title of the option, e.g.,
Australian Company Number (ACN). - Value string
- (String) - The value of the option.
- description String
- (String) - The description of the option.
- title String
- (String) - The human-readable title of the option, e.g.,
Australian Company Number (ACN). - value String
- (String) - The value of the option.
- description string
- (String) - The description of the option.
- title string
- (String) - The human-readable title of the option, e.g.,
Australian Company Number (ACN). - value string
- (String) - The value of the option.
- description str
- (String) - The description of the option.
- title str
- (String) - The human-readable title of the option, e.g.,
Australian Company Number (ACN). - value str
- (String) - The value of the option.
- description String
- (String) - The description of the option.
- title String
- (String) - The human-readable title of the option, e.g.,
Australian Company Number (ACN). - value String
- (String) - The value of the option.
Package Details
- Repository
- DNSimple pulumi/pulumi-dnsimple
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
dnsimpleTerraform Provider.
