sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ NetworkFirewall/ DescribeFirewallPolicy.ts

import type * as NFW from "@distilled.cloud/aws/network-firewall";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";
import type { FirewallPolicy } from "./FirewallPolicy.ts";

export interface DescribeFirewallPolicyRequest extends Omit<
  NFW.DescribeFirewallPolicyRequest,
  "FirewallPolicyArn" | "FirewallPolicyName"
> {}

/**
 * Runtime binding for `network-firewall:DescribeFirewallPolicy` — read the
 * bound {@link FirewallPolicy}'s definition (rule group references, default
 * actions, engine options); the policy ARN is injected automatically.
 *
 * Provide `NetworkFirewall.DescribeFirewallPolicyHttp` on the hosting Lambda
 * Function to satisfy the requirement.
 * ### Reading Policy State
 * **Example:** Read the Policy Definition
 * ```typescript
 * // init — grants network-firewall:DescribeFirewallPolicy on the policy
 * const describeFirewallPolicy =
 *   yield* AWS.NetworkFirewall.DescribeFirewallPolicy(policy);
 *
 * // runtime
 * const { FirewallPolicy } = yield* describeFirewallPolicy();
 * ```
 *
 * @binding
 */
export interface DescribeFirewallPolicy extends Binding.Service<
  DescribeFirewallPolicy,
  "AWS.NetworkFirewall.DescribeFirewallPolicy",
  (
    policy: FirewallPolicy,
  ) => Effect.Effect<
    (
      request?: DescribeFirewallPolicyRequest,
    ) => Effect.Effect<NFW.DescribeFirewallPolicyResponse, NFW.DescribeFirewallPolicyError>
  >
> {}

export const DescribeFirewallPolicy = Binding.Service<DescribeFirewallPolicy>(
  "AWS.NetworkFirewall.DescribeFirewallPolicy",
);