Package software.amazon.awscdk.services.eks

Interface AccessPolicyNameOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AccessPolicyNameOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:01.372Z")
@Stability(Stable)
public interface AccessPolicyNameOptions
extends software.amazon.jsii.JsiiSerializable

Represents the options required to create an Amazon EKS Access Policy using the fromAccessPolicyName() method.

Example:

 // 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());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AccessPolicyNameOptions.Builder	A builder for AccessPolicyNameOptions
static final class	AccessPolicyNameOptions.Jsii$Proxy	An implementation for AccessPolicyNameOptions

Method Summary

Modifier and Type	Method	Description
static AccessPolicyNameOptions.Builder	builder()
AccessScopeType	getAccessScopeType()	The scope of the access policy.
default List<String>	getNamespaces()	An optional array of Kubernetes namespaces to which the access policy applies.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccessScopeType

@Stability(Stable)
@NotNull
AccessScopeType getAccessScopeType()

The scope of the access policy.

This determines the level of access granted by the policy.

getNamespaces

@Stability(Stable)
@Nullable
default List<String> getNamespaces()

An optional array of Kubernetes namespaces to which the access policy applies.

Default: - no specific namespaces for this scope

builder

@Stability(Stable)
static AccessPolicyNameOptions.Builder builder()

Returns:

a AccessPolicyNameOptions.Builder of AccessPolicyNameOptions