@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
143 lines (142 loc) • 5.82 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Access Entry Policy Association for an EKS Cluster.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.eks.AccessPolicyAssociation("example", {
* clusterName: exampleAwsEksCluster.name,
* policyArn: "arn:aws:eks::aws:cluster-access-policy/AmazonEKSViewPolicy",
* principalArn: exampleAwsIamUser.arn,
* accessScope: {
* type: "namespace",
* namespaces: ["example-namespace"],
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import EKS access entry using the `cluster_name` `principal_arn` and `policy_arn` separated by an octothorp (`#`). For example:
*
* ```sh
* $ pulumi import aws:eks/accessPolicyAssociation:AccessPolicyAssociation my_eks_access_entry my_cluster_name#my_principal_arn#my_policy_arn
* ```
*/
export declare class AccessPolicyAssociation extends pulumi.CustomResource {
/**
* Get an existing AccessPolicyAssociation resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AccessPolicyAssociationState, opts?: pulumi.CustomResourceOptions): AccessPolicyAssociation;
/**
* Returns true if the given object is an instance of AccessPolicyAssociation. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is AccessPolicyAssociation;
/**
* The configuration block to determine the scope of the access. See `accessScope` Block below.
*/
readonly accessScope: pulumi.Output<outputs.eks.AccessPolicyAssociationAccessScope>;
/**
* Date and time in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) that the policy was associated.
*/
readonly associatedAt: pulumi.Output<string>;
/**
* Name of the EKS Cluster.
*/
readonly clusterName: pulumi.Output<string>;
/**
* Date and time in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) that the policy was updated.
*/
readonly modifiedAt: pulumi.Output<string>;
/**
* The ARN of the access policy that you're associating.
*/
readonly policyArn: pulumi.Output<string>;
/**
* The IAM Principal ARN which requires Authentication access to the EKS cluster.
*/
readonly principalArn: pulumi.Output<string>;
/**
* 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.
*/
readonly region: pulumi.Output<string>;
/**
* Create a AccessPolicyAssociation resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: AccessPolicyAssociationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AccessPolicyAssociation resources.
*/
export interface AccessPolicyAssociationState {
/**
* The configuration block to determine the scope of the access. See `accessScope` Block below.
*/
accessScope?: pulumi.Input<inputs.eks.AccessPolicyAssociationAccessScope>;
/**
* Date and time in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) that the policy was associated.
*/
associatedAt?: pulumi.Input<string>;
/**
* Name of the EKS Cluster.
*/
clusterName?: pulumi.Input<string>;
/**
* Date and time in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) that the policy was updated.
*/
modifiedAt?: pulumi.Input<string>;
/**
* The ARN of the access policy that you're associating.
*/
policyArn?: pulumi.Input<string>;
/**
* The IAM Principal ARN which requires Authentication access to the EKS cluster.
*/
principalArn?: pulumi.Input<string>;
/**
* 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>;
}
/**
* The set of arguments for constructing a AccessPolicyAssociation resource.
*/
export interface AccessPolicyAssociationArgs {
/**
* The configuration block to determine the scope of the access. See `accessScope` Block below.
*/
accessScope: pulumi.Input<inputs.eks.AccessPolicyAssociationAccessScope>;
/**
* Name of the EKS Cluster.
*/
clusterName: pulumi.Input<string>;
/**
* The ARN of the access policy that you're associating.
*/
policyArn: pulumi.Input<string>;
/**
* The IAM Principal ARN which requires Authentication access to the EKS cluster.
*/
principalArn: pulumi.Input<string>;
/**
* 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>;
}