@pulumi/dnsimple
Version:
A Pulumi package for creating and managing dnsimple cloud resources.
91 lines (90 loc) • 3.55 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
* Get information on the requirements of a registrant change.
*
* > **Note:** The registrant change API is currently in developer preview and is subject to change.
*
* Get registrant change requirements for the `dnsimple.com` domain and the contact with ID `1234`:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as dnsimple from "@pulumi/dnsimple";
*
* const example = dnsimple.getRegistrantChangeCheck({
* domainId: "dnsimple.com",
* contactId: "1234",
* });
* ```
*
* The following arguments are supported:
*
* * `domainId` - (Required) The name or ID of the domain.
* * `contactId` - (Required) The ID of the contact you are planning to change to.
*
* The following additional attributes are exported:
*
* * `contactId` - The ID of the contact you are planning to change to.
* * `domainId` - The name or ID of the domain.
* * `extendedAttributes` - (List) A list of extended attributes that are required for the registrant change. (see below for nested schema)
* * `registryOwnerChange` - (Boolean) Whether the registrant change is going to result in an owner change at the registry.
*
* <a id="nestedblock--extended_attributes"></a>
*/
export declare function getRegistrantChangeCheck(args: GetRegistrantChangeCheckArgs, opts?: pulumi.InvokeOptions): Promise<GetRegistrantChangeCheckResult>;
/**
* A collection of arguments for invoking getRegistrantChangeCheck.
*/
export interface GetRegistrantChangeCheckArgs {
contactId: string;
domainId: string;
}
/**
* A collection of values returned by getRegistrantChangeCheck.
*/
export interface GetRegistrantChangeCheckResult {
readonly contactId: string;
readonly domainId: string;
readonly extendedAttributes: outputs.GetRegistrantChangeCheckExtendedAttribute[];
readonly id: string;
readonly registryOwnerChange: boolean;
}
/**
* Get information on the requirements of a registrant change.
*
* > **Note:** The registrant change API is currently in developer preview and is subject to change.
*
* Get registrant change requirements for the `dnsimple.com` domain and the contact with ID `1234`:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as dnsimple from "@pulumi/dnsimple";
*
* const example = dnsimple.getRegistrantChangeCheck({
* domainId: "dnsimple.com",
* contactId: "1234",
* });
* ```
*
* The following arguments are supported:
*
* * `domainId` - (Required) The name or ID of the domain.
* * `contactId` - (Required) The ID of the contact you are planning to change to.
*
* The following additional attributes are exported:
*
* * `contactId` - The ID of the contact you are planning to change to.
* * `domainId` - The name or ID of the domain.
* * `extendedAttributes` - (List) A list of extended attributes that are required for the registrant change. (see below for nested schema)
* * `registryOwnerChange` - (Boolean) Whether the registrant change is going to result in an owner change at the registry.
*
* <a id="nestedblock--extended_attributes"></a>
*/
export declare function getRegistrantChangeCheckOutput(args: GetRegistrantChangeCheckOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetRegistrantChangeCheckResult>;
/**
* A collection of arguments for invoking getRegistrantChangeCheck.
*/
export interface GetRegistrantChangeCheckOutputArgs {
contactId: pulumi.Input<string>;
domainId: pulumi.Input<string>;
}