@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
144 lines • 5.01 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* The `scaleway.domain.Registration` data source retrieves information about an existing domain registration by domain name. Use it to get the `taskId` and `projectId` needed for importing a domain registration into Terraform state.
*
* Refer to the Domains and DNS [product documentation](https://www.scaleway.com/en/docs/network/domains-and-dns/) and [API documentation](https://www.scaleway.com/en/developers/api/domains-and-dns/) for more information.
*
* ## Example Usage
*
* ### Get taskId for import
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const example = scaleway.domain.getRegistration({
* domainName: "example.com",
* });
* export const importCommand = Promise.all([example, example]).then(([example, example1]) => `terraform import scaleway_domain_registration.example ${example.projectId}/${example1.taskId}`);
* ```
*
* ### With projectId filter
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const example = scaleway.domain.getRegistration({
* domainName: "example.com",
* projectId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
* });
* ```
*/
export declare function getRegistration(args: GetRegistrationArgs, opts?: pulumi.InvokeOptions): Promise<GetRegistrationResult>;
/**
* A collection of arguments for invoking getRegistration.
*/
export interface GetRegistrationArgs {
/**
* The domain name to look up (e.g. example.com).
*/
domainName: string;
/**
* The project ID to filter by. Defaults to the project ID in the provider configuration.
*/
projectId?: string;
}
/**
* A collection of values returned by getRegistration.
*/
export interface GetRegistrationResult {
/**
* Administrative contact details.
*/
readonly administrativeContacts: outputs.domain.GetRegistrationAdministrativeContact[];
/**
* Whether auto-renewal is enabled.
*/
readonly autoRenew: boolean;
/**
* Whether DNSSEC is enabled.
*/
readonly dnssec: boolean;
readonly domainName: string;
/**
* List of domain names in the registration.
*/
readonly domainNames: string[];
/**
* DNSSEC DS record configuration.
*/
readonly dsRecords: outputs.domain.GetRegistrationDsRecord[];
readonly durationInYears: number;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* ID of the owner contact.
*/
readonly ownerContactId: string;
/**
* Owner contact details (when lastname is API-compatible).
*/
readonly ownerContacts: outputs.domain.GetRegistrationOwnerContact[];
/**
* The project ID of the domain registration.
*/
readonly projectId?: string;
/**
* The task ID of the domain registration.
*/
readonly taskId: string;
/**
* Technical contact details.
*/
readonly technicalContacts: outputs.domain.GetRegistrationTechnicalContact[];
}
/**
* The `scaleway.domain.Registration` data source retrieves information about an existing domain registration by domain name. Use it to get the `taskId` and `projectId` needed for importing a domain registration into Terraform state.
*
* Refer to the Domains and DNS [product documentation](https://www.scaleway.com/en/docs/network/domains-and-dns/) and [API documentation](https://www.scaleway.com/en/developers/api/domains-and-dns/) for more information.
*
* ## Example Usage
*
* ### Get taskId for import
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const example = scaleway.domain.getRegistration({
* domainName: "example.com",
* });
* export const importCommand = Promise.all([example, example]).then(([example, example1]) => `terraform import scaleway_domain_registration.example ${example.projectId}/${example1.taskId}`);
* ```
*
* ### With projectId filter
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const example = scaleway.domain.getRegistration({
* domainName: "example.com",
* projectId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
* });
* ```
*/
export declare function getRegistrationOutput(args: GetRegistrationOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetRegistrationResult>;
/**
* A collection of arguments for invoking getRegistration.
*/
export interface GetRegistrationOutputArgs {
/**
* The domain name to look up (e.g. example.com).
*/
domainName: pulumi.Input<string>;
/**
* The project ID to filter by. Defaults to the project ID in the provider configuration.
*/
projectId?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=getRegistration.d.ts.map