@aws-sdk/client-eks/dist-types/commands/AssociateAccessPolicyCommand.d.ts

AWS SDK for JavaScript Eks Client for Node.js, Browser and React Native

import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
import { EKSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EKSClient";
import { AssociateAccessPolicyRequest, AssociateAccessPolicyResponse } from "../models/models_0";
/**
 * @public
 */
export type { __MetadataBearer };
export { $Command };
/**
 * @public
 *
 * The input for {@link AssociateAccessPolicyCommand}.
 */
export interface AssociateAccessPolicyCommandInput extends AssociateAccessPolicyRequest {
}
/**
 * @public
 *
 * The output of {@link AssociateAccessPolicyCommand}.
 */
export interface AssociateAccessPolicyCommandOutput extends AssociateAccessPolicyResponse, __MetadataBearer {
}
declare const AssociateAccessPolicyCommand_base: {
    new (input: AssociateAccessPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<AssociateAccessPolicyCommandInput, AssociateAccessPolicyCommandOutput, EKSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
    new (__0_0: AssociateAccessPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<AssociateAccessPolicyCommandInput, AssociateAccessPolicyCommandOutput, EKSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
 * <p>Associates an access policy and its scope to an access entry. For more information
 *             about associating access policies, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/access-policies.html">Associating and disassociating
 *                 access policies to and from access entries</a> in the <i>Amazon EKS User Guide</i>.</p>
 * @example
 * Use a bare-bones client and the command you need to make an API call.
 * ```javascript
 * import { EKSClient, AssociateAccessPolicyCommand } from "@aws-sdk/client-eks"; // ES Modules import
 * // const { EKSClient, AssociateAccessPolicyCommand } = require("@aws-sdk/client-eks"); // CommonJS import
 * const client = new EKSClient(config);
 * const input = { // AssociateAccessPolicyRequest
 *   clusterName: "STRING_VALUE", // required
 *   principalArn: "STRING_VALUE", // required
 *   policyArn: "STRING_VALUE", // required
 *   accessScope: { // AccessScope
 *     type: "cluster" || "namespace",
 *     namespaces: [ // StringList
 *       "STRING_VALUE",
 *     ],
 *   },
 * };
 * const command = new AssociateAccessPolicyCommand(input);
 * const response = await client.send(command);
 * // { // AssociateAccessPolicyResponse
 * //   clusterName: "STRING_VALUE",
 * //   principalArn: "STRING_VALUE",
 * //   associatedAccessPolicy: { // AssociatedAccessPolicy
 * //     policyArn: "STRING_VALUE",
 * //     accessScope: { // AccessScope
 * //       type: "cluster" || "namespace",
 * //       namespaces: [ // StringList
 * //         "STRING_VALUE",
 * //       ],
 * //     },
 * //     associatedAt: new Date("TIMESTAMP"),
 * //     modifiedAt: new Date("TIMESTAMP"),
 * //   },
 * // };
 *
 * ```
 *
 * @param AssociateAccessPolicyCommandInput - {@link AssociateAccessPolicyCommandInput}
 * @returns {@link AssociateAccessPolicyCommandOutput}
 * @see {@link AssociateAccessPolicyCommandInput} for command's `input` shape.
 * @see {@link AssociateAccessPolicyCommandOutput} for command's `response` shape.
 * @see {@link EKSClientResolvedConfig | config} for EKSClient's `config` shape.
 *
 * @throws {@link InvalidParameterException} (client fault)
 *  <p>The specified parameter is invalid. Review the available parameters for the API
 *             request.</p>
 *
 * @throws {@link InvalidRequestException} (client fault)
 *  <p>The request is invalid given the state of the cluster. Check the state of the cluster
 *             and the associated operations.</p>
 *
 * @throws {@link ResourceNotFoundException} (client fault)
 *  <p>The specified resource could not be found. You can view your available clusters with
 *                 <code>ListClusters</code>. You can view your available managed node groups with
 *                 <code>ListNodegroups</code>. Amazon EKS clusters and node groups are Amazon Web Services Region
 *             specific.</p>
 *
 * @throws {@link ServerException} (server fault)
 *  <p>These errors are usually caused by a server-side issue.</p>
 *
 * @throws {@link EKSServiceException}
 * <p>Base exception class for all service exceptions from EKS service.</p>
 *
 * @public
 */
export declare class AssociateAccessPolicyCommand extends AssociateAccessPolicyCommand_base {
    /** @internal type navigation helper, not in runtime. */
    protected static __types: {
        api: {
            input: AssociateAccessPolicyRequest;
            output: AssociateAccessPolicyResponse;
        };
        sdk: {
            input: AssociateAccessPolicyCommandInput;
            output: AssociateAccessPolicyCommandOutput;
        };
    };
}