AWS CDK Reference

Appearance

v2.274.0

AccessPolicy Class ​

Represents an Amazon EKS Access Policy that implements the IAccessPolicy interface.

Source
aws-eks/lib/access-entry.ts
Type last changed
v2.146.0 · 13 Jun 2024

Example ​

ts
// AmazonEKSClusterAdminPolicy with `cluster` scope
eks.AccessPolicy.fromAccessPolicyName('AmazonEKSClusterAdminPolicy', {
  accessScopeType: eks.AccessScopeType.CLUSTER,
});
// AmazonEKSAdminPolicy with `namespace` scope
eks.AccessPolicy.fromAccessPolicyName('AmazonEKSAdminPolicy', {
  accessScopeType: eks.AccessScopeType.NAMESPACE,
  namespaces: ['foo', 'bar'] } );
python
# AmazonEKSClusterAdminPolicy with `cluster` scope
eks.AccessPolicy.from_access_policy_name("AmazonEKSClusterAdminPolicy",
    access_scope_type=eks.AccessScopeType.CLUSTER
)
# AmazonEKSAdminPolicy with `namespace` scope
eks.AccessPolicy.from_access_policy_name("AmazonEKSAdminPolicy",
    access_scope_type=eks.AccessScopeType.NAMESPACE,
    namespaces=["foo", "bar"]
)
java
// AmazonEKSClusterAdminPolicy with `cluster` scope
AccessPolicy.fromAccessPolicyName("AmazonEKSClusterAdminPolicy", AccessPolicyNameOptions.builder()
        .accessScopeType(AccessScopeType.CLUSTER)
        .build());
// AmazonEKSAdminPolicy with `namespace` scope
AccessPolicy.fromAccessPolicyName("AmazonEKSAdminPolicy", AccessPolicyNameOptions.builder()
        .accessScopeType(AccessScopeType.NAMESPACE)
        .namespaces(List.of("foo", "bar"))
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
// AmazonEKSClusterAdminPolicy with `cluster` scope
AccessPolicy.FromAccessPolicyName("AmazonEKSClusterAdminPolicy", new AccessPolicyNameOptions {
    AccessScopeType = AccessScopeType.CLUSTER
});
// AmazonEKSAdminPolicy with `namespace` scope
AccessPolicy.FromAccessPolicyName("AmazonEKSAdminPolicy", new AccessPolicyNameOptions {
    AccessScopeType = AccessScopeType.NAMESPACE,
    Namespaces = new [] { "foo", "bar" }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// AmazonEKSClusterAdminPolicy with `cluster` scope
eks.AccessPolicy_FromAccessPolicyName(jsii.String("AmazonEKSClusterAdminPolicy"), &AccessPolicyNameOptions{
	AccessScopeType: eks.AccessScopeType_CLUSTER,
})
// AmazonEKSAdminPolicy with `namespace` scope
eks.AccessPolicy_FromAccessPolicyName(jsii.String("AmazonEKSAdminPolicy"), &AccessPolicyNameOptions{
	AccessScopeType: eks.AccessScopeType_NAMESPACE,
	Namespaces: []*string{
		jsii.String("foo"),
		jsii.String("bar"),
	},
})

Initializer ​

ts
new AccessPolicy(props: AccessPolicyProps)
python
AccessPolicy(props: AccessPolicyProps)
java
new AccessPolicy(AccessPolicyProps props)
csharp
new AccessPolicy(AccessPolicyProps props)
go
NewAccessPolicy(Props AccessPolicyProps)

Properties ​

accessScopeAccessScopeaccess_scopeAccessScopeaccessScopeAccessScopeAccessScopeAccessScopeAccessScopeAccessScoperequired#
The scope of the access policy, which determines the level of access granted.
policystringpolicystrpolicyStringPolicystringPolicy*stringrequired#
The access policy itself, which defines the specific permissions.

Methods ​

fromAccessPolicyName(policyName: string, options: AccessPolicyNameOptions): IAccessPolicy@staticmethod def from_access_policy_name(policy_name: str, options: AccessPolicyNameOptions) -> IAccessPolicypublic static IAccessPolicy fromAccessPolicyName(String policyName, AccessPolicyNameOptions options)public static IAccessPolicy FromAccessPolicyName(string policyName, AccessPolicyNameOptions options)func FromAccessPolicyName(PolicyName *string, Options AccessPolicyNameOptions) IAccessPolicystatic#
Import AccessPolicy by name.