@pulumi/yandex
Version:
A Pulumi package for creating and managing yandex cloud resources.
72 lines (71 loc) • 2.33 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import { output as outputs } from "./types";
/**
* Get information about a Yandex CDN Origin Group. For more information, see
* [the official documentation](https://cloud.yandex.ru/docs/cdn/concepts/origins).
*
* > **_NOTE:_** CDN provider must be activated prior usage of CDN resources, either via UI console or via yc cli command: ```yc cdn provider activate --folder-id <folder-id> --type gcore```
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as yandex from "@pulumi/yandex";
*
* const myGroup = pulumi.output(yandex.getCdnOriginGroup({
* originGroupId: Number.parseFloat("some_instance_id"),
* }));
*
* export const originGroupName = myGroup.name!;
* ```
*/
export declare function getCdnOriginGroup(args?: GetCdnOriginGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetCdnOriginGroupResult>;
/**
* A collection of arguments for invoking getCdnOriginGroup.
*/
export interface GetCdnOriginGroupArgs {
/**
* Folder that the resource belongs to. If value is omitted, the default provider folder is used.
*/
folderId?: string;
/**
* Name of the origin group.
*/
name?: string;
/**
* The ID of a specific origin group.
*/
originGroupId?: number;
}
/**
* A collection of values returned by getCdnOriginGroup.
*/
export interface GetCdnOriginGroupResult {
readonly folderId: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly name: string;
readonly originGroupId: number;
readonly origins: outputs.GetCdnOriginGroupOrigin[];
readonly useNext: boolean;
}
export declare function getCdnOriginGroupOutput(args?: GetCdnOriginGroupOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetCdnOriginGroupResult>;
/**
* A collection of arguments for invoking getCdnOriginGroup.
*/
export interface GetCdnOriginGroupOutputArgs {
/**
* Folder that the resource belongs to. If value is omitted, the default provider folder is used.
*/
folderId?: pulumi.Input<string>;
/**
* Name of the origin group.
*/
name?: pulumi.Input<string>;
/**
* The ID of a specific origin group.
*/
originGroupId?: pulumi.Input<number>;
}