#[non_exhaustive]pub struct CreateAccessEntryInput {
pub cluster_name: Option<String>,
pub principal_arn: Option<String>,
pub kubernetes_groups: Option<Vec<String>>,
pub tags: Option<HashMap<String, String>>,
pub client_request_token: Option<String>,
pub username: Option<String>,
pub type: Option<String>,
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.cluster_name: Option<String>
The name of your cluster.
principal_arn: Option<String>
The ARN of the IAM principal for the AccessEntry
. You can specify one ARN for each access entry. You can't specify the same ARN in more than one access entry. This value can't be changed after access entry creation.
The valid principals differ depending on the type of the access entry in the type
field. For STANDARD
access entries, you can use every IAM principal type. For nodes (EC2
(for EKS Auto Mode), EC2_LINUX
, EC2_WINDOWS
, FARGATE_LINUX
, and HYBRID_LINUX
), the only valid ARN is IAM roles. You can't use the STS session principal type with access entries because this is a temporary principal for each session and not a permanent identity that can be assigned permissions.
IAM best practices recommend using IAM roles with temporary credentials, rather than IAM users with long-term credentials.
kubernetes_groups: Option<Vec<String>>
The value for name
that you've specified for kind: Group
as a subject
in a Kubernetes RoleBinding
or ClusterRoleBinding
object. Amazon EKS doesn't confirm that the value for name
exists in any bindings on your cluster. You can specify one or more names.
Kubernetes authorizes the principalArn
of the access entry to access any cluster objects that you've specified in a Kubernetes Role
or ClusterRole
object that is also specified in a binding's roleRef
. For more information about creating Kubernetes RoleBinding
, ClusterRoleBinding
, Role
, or ClusterRole
objects, see Using RBAC Authorization in the Kubernetes documentation.
If you want Amazon EKS to authorize the principalArn
(instead of, or in addition to Kubernetes authorizing the principalArn
), you can associate one or more access policies to the access entry using AssociateAccessPolicy
. If you associate any access policies, the principalARN
has all permissions assigned in the associated access policies and all permissions in any Kubernetes Role
or ClusterRole
objects that the group names are bound to.
Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.
client_request_token: Option<String>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
username: Option<String>
The username to authenticate to Kubernetes with. We recommend not specifying a username and letting Amazon EKS specify it for you. For more information about the value Amazon EKS specifies for you, or constraints before specifying your own username, see Creating access entries in the Amazon EKS User Guide.
type: Option<String>
The type of the new access entry. Valid values are STANDARD
, FARGATE_LINUX
, EC2_LINUX
, EC2_WINDOWS
, EC2
(for EKS Auto Mode), HYBRID_LINUX
, and HYPERPOD_LINUX
.
If the principalArn
is for an IAM role that's used for self-managed Amazon EC2 nodes, specify EC2_LINUX
or EC2_WINDOWS
. Amazon EKS grants the necessary permissions to the node for you. If the principalArn
is for any other purpose, specify STANDARD
. If you don't specify a value, Amazon EKS sets the value to STANDARD
. If you have the access mode of the cluster set to API_AND_CONFIG_MAP
, it's unnecessary to create access entries for IAM roles used with Fargate profiles or managed Amazon EC2 nodes, because Amazon EKS creates entries in the aws-auth
ConfigMap
for the roles. You can't change this value once you've created the access entry.
If you set the value to EC2_LINUX
or EC2_WINDOWS
, you can't specify values for kubernetesGroups
, or associate an AccessPolicy
to the access entry.
Implementations§
Source§impl CreateAccessEntryInput
impl CreateAccessEntryInput
Sourcepub fn cluster_name(&self) -> Option<&str>
pub fn cluster_name(&self) -> Option<&str>
The name of your cluster.
Sourcepub fn principal_arn(&self) -> Option<&str>
pub fn principal_arn(&self) -> Option<&str>
The ARN of the IAM principal for the AccessEntry
. You can specify one ARN for each access entry. You can't specify the same ARN in more than one access entry. This value can't be changed after access entry creation.
The valid principals differ depending on the type of the access entry in the type
field. For STANDARD
access entries, you can use every IAM principal type. For nodes (EC2
(for EKS Auto Mode), EC2_LINUX
, EC2_WINDOWS
, FARGATE_LINUX
, and HYBRID_LINUX
), the only valid ARN is IAM roles. You can't use the STS session principal type with access entries because this is a temporary principal for each session and not a permanent identity that can be assigned permissions.
IAM best practices recommend using IAM roles with temporary credentials, rather than IAM users with long-term credentials.
Sourcepub fn kubernetes_groups(&self) -> &[String]
pub fn kubernetes_groups(&self) -> &[String]
The value for name
that you've specified for kind: Group
as a subject
in a Kubernetes RoleBinding
or ClusterRoleBinding
object. Amazon EKS doesn't confirm that the value for name
exists in any bindings on your cluster. You can specify one or more names.
Kubernetes authorizes the principalArn
of the access entry to access any cluster objects that you've specified in a Kubernetes Role
or ClusterRole
object that is also specified in a binding's roleRef
. For more information about creating Kubernetes RoleBinding
, ClusterRoleBinding
, Role
, or ClusterRole
objects, see Using RBAC Authorization in the Kubernetes documentation.
If you want Amazon EKS to authorize the principalArn
(instead of, or in addition to Kubernetes authorizing the principalArn
), you can associate one or more access policies to the access entry using AssociateAccessPolicy
. If you associate any access policies, the principalARN
has all permissions assigned in the associated access policies and all permissions in any Kubernetes Role
or ClusterRole
objects that the group names are bound to.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .kubernetes_groups.is_none()
.
Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.
Sourcepub fn client_request_token(&self) -> Option<&str>
pub fn client_request_token(&self) -> Option<&str>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Sourcepub fn username(&self) -> Option<&str>
pub fn username(&self) -> Option<&str>
The username to authenticate to Kubernetes with. We recommend not specifying a username and letting Amazon EKS specify it for you. For more information about the value Amazon EKS specifies for you, or constraints before specifying your own username, see Creating access entries in the Amazon EKS User Guide.
Sourcepub fn type(&self) -> Option<&str>
pub fn type(&self) -> Option<&str>
The type of the new access entry. Valid values are STANDARD
, FARGATE_LINUX
, EC2_LINUX
, EC2_WINDOWS
, EC2
(for EKS Auto Mode), HYBRID_LINUX
, and HYPERPOD_LINUX
.
If the principalArn
is for an IAM role that's used for self-managed Amazon EC2 nodes, specify EC2_LINUX
or EC2_WINDOWS
. Amazon EKS grants the necessary permissions to the node for you. If the principalArn
is for any other purpose, specify STANDARD
. If you don't specify a value, Amazon EKS sets the value to STANDARD
. If you have the access mode of the cluster set to API_AND_CONFIG_MAP
, it's unnecessary to create access entries for IAM roles used with Fargate profiles or managed Amazon EC2 nodes, because Amazon EKS creates entries in the aws-auth
ConfigMap
for the roles. You can't change this value once you've created the access entry.
If you set the value to EC2_LINUX
or EC2_WINDOWS
, you can't specify values for kubernetesGroups
, or associate an AccessPolicy
to the access entry.
Source§impl CreateAccessEntryInput
impl CreateAccessEntryInput
Sourcepub fn builder() -> CreateAccessEntryInputBuilder
pub fn builder() -> CreateAccessEntryInputBuilder
Creates a new builder-style object to manufacture CreateAccessEntryInput
.
Trait Implementations§
Source§impl Clone for CreateAccessEntryInput
impl Clone for CreateAccessEntryInput
Source§fn clone(&self) -> CreateAccessEntryInput
fn clone(&self) -> CreateAccessEntryInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateAccessEntryInput
impl Debug for CreateAccessEntryInput
Source§impl PartialEq for CreateAccessEntryInput
impl PartialEq for CreateAccessEntryInput
impl StructuralPartialEq for CreateAccessEntryInput
Auto Trait Implementations§
impl Freeze for CreateAccessEntryInput
impl RefUnwindSafe for CreateAccessEntryInput
impl Send for CreateAccessEntryInput
impl Sync for CreateAccessEntryInput
impl Unpin for CreateAccessEntryInput
impl UnwindSafe for CreateAccessEntryInput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);