AccessPolicyAssociation class
Access Entry Policy Association for an EKS Cluster.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.eks.AccessPolicyAssociation("example", {
accessScope: {
type: "namespace",
namespaces: ["example-namespace"],
},
clusterName: exampleAwsEksCluster.name,
policyArn: "arn:aws:eks::aws:cluster-access-policy/AmazonEKSViewPolicy",
principalArn: exampleAwsIamUser.arn,
});
import pulumi
import pulumi_aws as aws
example = aws.eks.AccessPolicyAssociation("example",
access_scope={
"type": "namespace",
"namespaces": ["example-namespace"],
},
cluster_name=example_aws_eks_cluster["name"],
policy_arn="arn:aws:eks::aws:cluster-access-policy/AmazonEKSViewPolicy",
principal_arn=example_aws_iam_user["arn"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Eks.AccessPolicyAssociation("example", new()
{
AccessScope = new Aws.Eks.Inputs.AccessPolicyAssociationAccessScopeArgs
{
Type = "namespace",
Namespaces = new[]
{
"example-namespace",
},
},
ClusterName = exampleAwsEksCluster.Name,
PolicyArn = "arn:aws:eks::aws:cluster-access-policy/AmazonEKSViewPolicy",
PrincipalArn = exampleAwsIamUser.Arn,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/eks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := eks.NewAccessPolicyAssociation(ctx, "example", &eks.AccessPolicyAssociationArgs{
AccessScope: &eks.AccessPolicyAssociationAccessScopeArgs{
Type: pulumi.String("namespace"),
Namespaces: pulumi.StringArray{
pulumi.String("example-namespace"),
},
},
ClusterName: pulumi.Any(exampleAwsEksCluster.Name),
PolicyArn: pulumi.String("arn:aws:eks::aws:cluster-access-policy/AmazonEKSViewPolicy"),
PrincipalArn: pulumi.Any(exampleAwsIamUser.Arn),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_eks_accesspolicyassociation" "example" {
access_scope = {
type = "namespace"
namespaces = ["example-namespace"]
}
cluster_name = exampleAwsEksCluster.name
policy_arn = "arn:aws:eks::aws:cluster-access-policy/AmazonEKSViewPolicy"
principal_arn = exampleAwsIamUser.arn
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.eks.AccessPolicyAssociation;
import com.pulumi.aws.eks.AccessPolicyAssociationArgs;
import com.pulumi.aws.eks.inputs.AccessPolicyAssociationAccessScopeArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new AccessPolicyAssociation("example", AccessPolicyAssociationArgs.builder()
.accessScope(AccessPolicyAssociationAccessScopeArgs.builder()
.type("namespace")
.namespaces("example-namespace")
.build())
.clusterName(exampleAwsEksCluster.name())
.policyArn("arn:aws:eks::aws:cluster-access-policy/AmazonEKSViewPolicy")
.principalArn(exampleAwsIamUser.arn())
.build());
}
}
resources:
example:
type: aws:eks:AccessPolicyAssociation
properties:
accessScope:
type: namespace
namespaces:
- example-namespace
clusterName: ${exampleAwsEksCluster.name}
policyArn: arn:aws:eks::aws:cluster-access-policy/AmazonEKSViewPolicy
principalArn: ${exampleAwsIamUser.arn}
Import
Identity Schema
Required
clusterName(String) Name of the EKS Cluster.principalArn(String) IAM principal ARN.policyArn- (String) Access policy ARN.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import Access Entry Policy Associations using clusterName, principalArn, and policyArn separated by an octothorp (#). For example:
$ pulumi import aws:eks/accessPolicyAssociation:AccessPolicyAssociation example example-cluster#arn:aws:iam::123456789012:role/example#arn:aws:eks::aws:cluster-access-policy/AmazonEKSViewPolicy
Constructors
- AccessPolicyAssociation(String name, {AccessPolicyAssociationArgs? args, CustomResourceOptions? options})
-
Creates a new AccessPolicyAssociation.
nameThe Pulumi resource name.argsArguments used to configure this AccessPolicyAssociation. The set of arguments for AccessPolicyAssociation.optionsResource options controlling this resource's behavior. - AccessPolicyAssociation.reference(String urn)
- Creates a typed reference to an existing AccessPolicyAssociation resource.
Properties
-
accessScope
↔ Output<
AccessPolicyAssociationAccessScope> -
The configuration block to determine the scope of the access. See
accessScopeBlock below.latefinal -
associatedAt
↔ Output<
String> -
Date and time in RFC3339 format that the policy was associated.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
clusterName
↔ Output<
String> -
Name of the EKS Cluster.
latefinal
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
modifiedAt
↔ Output<
String> -
Date and time in RFC3339 format that the policy was updated.
latefinal
-
policyArn
↔ Output<
String> -
The ARN of the access policy that you're associating.
latefinal
-
principalArn
↔ Output<
String> -
The IAM Principal ARN which requires Authentication access to the EKS cluster.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {AccessPolicyAssociationState? state, CustomResourceOptions? options}) → AccessPolicyAssociation -
Gets an existing AccessPolicyAssociation resource's state with the given
nameandid.