@pulumi/yandex
Version:
A Pulumi package for creating and managing yandex cloud resources.
114 lines (113 loc) • 3.21 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import { output as outputs } from "./types";
/**
* Get information about a Yandex VPC Security Group. For more information, see
* [Yandex.Cloud VPC](https://cloud.yandex.com/docs/vpc/concepts/security-groups).
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as yandex from "@pulumi/yandex";
*
* const group1 = pulumi.output(yandex.getVpcSecurityGroup({
* securityGroupId: "my-id",
* }));
* ```
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as yandex from "@pulumi/yandex";
*
* const group1 = pulumi.output(yandex.getVpcSecurityGroup({
* name: "my-group1",
* }));
* ```
*
* This data source is used to define Security Group that can be used by other resources.
*/
export declare function getVpcSecurityGroup(args?: GetVpcSecurityGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetVpcSecurityGroupResult>;
/**
* A collection of arguments for invoking getVpcSecurityGroup.
*/
export interface GetVpcSecurityGroupArgs {
/**
* Folder that the resource belongs to. If value is omitted, the default provider folder is used.
*/
folderId?: string;
/**
* - Name of the security group.
*/
name?: string;
/**
* Security Group ID.
*/
securityGroupId?: string;
}
/**
* A collection of values returned by getVpcSecurityGroup.
*/
export interface GetVpcSecurityGroupResult {
/**
* Creation timestamp of this security group.
*/
readonly createdAt: string;
/**
* Description of the rule.
*/
readonly description: string;
/**
* A list of egress rules. The structure is documented below.
*/
readonly egresses: outputs.GetVpcSecurityGroupEgress[];
/**
* ID of the folder this security group belongs to.
*/
readonly folderId: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* A list of ingress rules. The structure is documented below.
*/
readonly ingresses: outputs.GetVpcSecurityGroupIngress[];
/**
* Labels to assign to this rule.
*/
readonly labels: {
[key: string]: string;
};
/**
* Name of the security group.
*/
readonly name: string;
/**
* ID of the network this security group belongs to.
*/
readonly networkId: string;
/**
* Target security group ID for this rule.
*/
readonly securityGroupId: string;
/**
* Status of this security group.
*/
readonly status: string;
}
export declare function getVpcSecurityGroupOutput(args?: GetVpcSecurityGroupOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetVpcSecurityGroupResult>;
/**
* A collection of arguments for invoking getVpcSecurityGroup.
*/
export interface GetVpcSecurityGroupOutputArgs {
/**
* Folder that the resource belongs to. If value is omitted, the default provider folder is used.
*/
folderId?: pulumi.Input<string>;
/**
* - Name of the security group.
*/
name?: pulumi.Input<string>;
/**
* Security Group ID.
*/
securityGroupId?: pulumi.Input<string>;
}