UNPKG

@pulumi/aws

Version:

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

135 lines (134 loc) 4.41 kB
import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * `aws.vpc.getSecurityGroupRule` provides details about a specific security group rule. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = aws.vpc.getSecurityGroupRule({ * securityGroupRuleId: securityGroupRuleId, * }); * ``` */ export declare function getSecurityGroupRule(args?: GetSecurityGroupRuleArgs, opts?: pulumi.InvokeOptions): Promise<GetSecurityGroupRuleResult>; /** * A collection of arguments for invoking getSecurityGroupRule. */ export interface GetSecurityGroupRuleArgs { /** * Configuration block(s) for filtering. Detailed below. * * The arguments of this data source act as filters for querying the available * security group rules. The given filters must match exactly one security group rule * whose data will be exported as attributes. */ filters?: inputs.vpc.GetSecurityGroupRuleFilter[]; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: string; /** * ID of the security group rule to select. */ securityGroupRuleId?: string; } /** * A collection of values returned by getSecurityGroupRule. */ export interface GetSecurityGroupRuleResult { /** * The Amazon Resource Name (ARN) of the security group rule. */ readonly arn: string; /** * The destination IPv4 CIDR range. */ readonly cidrIpv4: string; /** * The destination IPv6 CIDR range. */ readonly cidrIpv6: string; /** * The security group rule description. */ readonly description: string; readonly filters?: outputs.vpc.GetSecurityGroupRuleFilter[]; /** * The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. */ readonly fromPort: number; readonly id: string; /** * The IP protocol name or number. Use `-1` to specify all protocols. */ readonly ipProtocol: string; /** * Indicates whether the security group rule is an outbound rule. */ readonly isEgress: boolean; /** * The ID of the destination prefix list. */ readonly prefixListId: string; /** * The destination security group that is referenced in the rule. */ readonly referencedSecurityGroupId: string; readonly region: string; /** * The ID of the security group. */ readonly securityGroupId: string; readonly securityGroupRuleId: string; /** * A map of tags assigned to the resource. */ readonly tags: { [key: string]: string; }; /** * (Optional) The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. */ readonly toPort: number; } /** * `aws.vpc.getSecurityGroupRule` provides details about a specific security group rule. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = aws.vpc.getSecurityGroupRule({ * securityGroupRuleId: securityGroupRuleId, * }); * ``` */ export declare function getSecurityGroupRuleOutput(args?: GetSecurityGroupRuleOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetSecurityGroupRuleResult>; /** * A collection of arguments for invoking getSecurityGroupRule. */ export interface GetSecurityGroupRuleOutputArgs { /** * Configuration block(s) for filtering. Detailed below. * * The arguments of this data source act as filters for querying the available * security group rules. The given filters must match exactly one security group rule * whose data will be exported as attributes. */ filters?: pulumi.Input<pulumi.Input<inputs.vpc.GetSecurityGroupRuleFilterArgs>[]>; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input<string>; /** * ID of the security group rule to select. */ securityGroupRuleId?: pulumi.Input<string>; }