All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • org.cdk8s.plus31.Role Maven / Gradle / Ivy

    package org.cdk8s.plus31;

/**
 * Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.
 */
@javax.annotation.Generated(value = "jsii-pacmak/1.105.0 (build 0a2adcb)", date = "2024-11-15T12:15:24.888Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Jsii(module = org.cdk8s.plus31.$Module.class, fqn = "cdk8s-plus-31.Role")
public class Role extends org.cdk8s.plus31.Resource implements org.cdk8s.plus31.IRole {

    protected Role(final software.amazon.jsii.JsiiObjectRef objRef) {
        super(objRef);
    }

    protected Role(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
        super(initializationMode);
    }

    /**
     * @param scope This parameter is required.
     * @param id This parameter is required.
     * @param props
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public Role(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.Nullable org.cdk8s.plus31.RoleProps props) {
        super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
        software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), props });
    }

    /**
     * @param scope This parameter is required.
     * @param id This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public Role(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id) {
        super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
        software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required") });
    }

    /**
     * Imports a role from the cluster as a reference.
     * 
    
     * @param scope This parameter is required.
     * @param id This parameter is required.
     * @param name This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public static @org.jetbrains.annotations.NotNull org.cdk8s.plus31.IRole fromRoleName(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull java.lang.String name) {
        return software.amazon.jsii.JsiiObject.jsiiStaticCall(org.cdk8s.plus31.Role.class, "fromRoleName", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus31.IRole.class), new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(name, "name is required") });
    }

    /**
     * Add permission to perform a list of HTTP verbs on a collection of resources.
     * 
    
     * @see https://kubernetes.io/docs/reference/access-authn-authz/authorization/#determine-the-request-verb
     * @param verbs This parameter is required.
     * @param resources The resource(s) to apply to. This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public void allow(final @org.jetbrains.annotations.NotNull java.util.List verbs, final @org.jetbrains.annotations.NotNull org.cdk8s.plus31.IApiResource... resources) {
        software.amazon.jsii.Kernel.call(this, "allow", software.amazon.jsii.NativeType.VOID, java.util.stream.Stream.concat(java.util.Arrays.stream(new Object[] { java.util.Objects.requireNonNull(verbs, "verbs is required") }), java.util.Arrays.stream(resources)).toArray(Object[]::new));
    }

    /**
     * Add "create" permission for the resources.
     * 
    
     * @param resources The resource(s) to apply to. This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public void allowCreate(final @org.jetbrains.annotations.NotNull org.cdk8s.plus31.IApiResource... resources) {
        software.amazon.jsii.Kernel.call(this, "allowCreate", software.amazon.jsii.NativeType.VOID, java.util.Arrays.stream(resources).toArray(Object[]::new));
    }

    /**
     * Add "delete" permission for the resources.
     * 
    
     * @param resources The resource(s) to apply to. This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public void allowDelete(final @org.jetbrains.annotations.NotNull org.cdk8s.plus31.IApiResource... resources) {
        software.amazon.jsii.Kernel.call(this, "allowDelete", software.amazon.jsii.NativeType.VOID, java.util.Arrays.stream(resources).toArray(Object[]::new));
    }

    /**
     * Add "deletecollection" permission for the resources.
     * 
    
     * @param resources The resource(s) to apply to. This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public void allowDeleteCollection(final @org.jetbrains.annotations.NotNull org.cdk8s.plus31.IApiResource... resources) {
        software.amazon.jsii.Kernel.call(this, "allowDeleteCollection", software.amazon.jsii.NativeType.VOID, java.util.Arrays.stream(resources).toArray(Object[]::new));
    }

    /**
     * Add "get" permission for the resources.
     * 
    
     * @param resources The resource(s) to apply to. This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public void allowGet(final @org.jetbrains.annotations.NotNull org.cdk8s.plus31.IApiResource... resources) {
        software.amazon.jsii.Kernel.call(this, "allowGet", software.amazon.jsii.NativeType.VOID, java.util.Arrays.stream(resources).toArray(Object[]::new));
    }

    /**
     * Add "list" permission for the resources.
     * 
    
     * @param resources The resource(s) to apply to. This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public void allowList(final @org.jetbrains.annotations.NotNull org.cdk8s.plus31.IApiResource... resources) {
        software.amazon.jsii.Kernel.call(this, "allowList", software.amazon.jsii.NativeType.VOID, java.util.Arrays.stream(resources).toArray(Object[]::new));
    }

    /**
     * Add "patch" permission for the resources.
     * 
    
     * @param resources The resource(s) to apply to. This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public void allowPatch(final @org.jetbrains.annotations.NotNull org.cdk8s.plus31.IApiResource... resources) {
        software.amazon.jsii.Kernel.call(this, "allowPatch", software.amazon.jsii.NativeType.VOID, java.util.Arrays.stream(resources).toArray(Object[]::new));
    }

    /**
     * Add "get", "list", and "watch" permissions for the resources.
     * 
    
     * @param resources The resource(s) to apply to. This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public void allowRead(final @org.jetbrains.annotations.NotNull org.cdk8s.plus31.IApiResource... resources) {
        software.amazon.jsii.Kernel.call(this, "allowRead", software.amazon.jsii.NativeType.VOID, java.util.Arrays.stream(resources).toArray(Object[]::new));
    }

    /**
     * Add "get", "list", "watch", "create", "update", "patch", "delete", and "deletecollection" permissions for the resources.
     * 
    
     * @param resources The resource(s) to apply to. This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public void allowReadWrite(final @org.jetbrains.annotations.NotNull org.cdk8s.plus31.IApiResource... resources) {
        software.amazon.jsii.Kernel.call(this, "allowReadWrite", software.amazon.jsii.NativeType.VOID, java.util.Arrays.stream(resources).toArray(Object[]::new));
    }

    /**
     * Add "update" permission for the resources.
     * 
    
     * @param resources The resource(s) to apply to. This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public void allowUpdate(final @org.jetbrains.annotations.NotNull org.cdk8s.plus31.IApiResource... resources) {
        software.amazon.jsii.Kernel.call(this, "allowUpdate", software.amazon.jsii.NativeType.VOID, java.util.Arrays.stream(resources).toArray(Object[]::new));
    }

    /**
     * Add "watch" permission for the resources.
     * 
    
     * @param resources The resource(s) to apply to. This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public void allowWatch(final @org.jetbrains.annotations.NotNull org.cdk8s.plus31.IApiResource... resources) {
        software.amazon.jsii.Kernel.call(this, "allowWatch", software.amazon.jsii.NativeType.VOID, java.util.Arrays.stream(resources).toArray(Object[]::new));
    }

    /**
     * Create a RoleBinding that binds the permissions in this Role to a list of subjects, that will only apply this role's namespace.
     * 
    
     * @param subjects a list of subjects to bind to. This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public @org.jetbrains.annotations.NotNull org.cdk8s.plus31.RoleBinding bind(final @org.jetbrains.annotations.NotNull org.cdk8s.plus31.ISubject... subjects) {
        return software.amazon.jsii.Kernel.call(this, "bind", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus31.RoleBinding.class), java.util.Arrays.stream(subjects).toArray(Object[]::new));
    }

    /**
     * The underlying cdk8s API object.
     * 
    
     * @see base.Resource.apiObject
     */
    @Override
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    protected @org.jetbrains.annotations.NotNull org.cdk8s.ApiObject getApiObject() {
        return software.amazon.jsii.Kernel.get(this, "apiObject", software.amazon.jsii.NativeType.forClass(org.cdk8s.ApiObject.class));
    }

    /**
     * The name of a resource type as it appears in the relevant API endpoint.
     */
    @Override
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public @org.jetbrains.annotations.NotNull java.lang.String getResourceType() {
        return software.amazon.jsii.Kernel.get(this, "resourceType", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
    }

    /**
     * Rules associaated with this Role.
     * 
    
     * Returns a copy, use allow to add rules.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public @org.jetbrains.annotations.NotNull java.util.List getRules() {
        return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "rules", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(org.cdk8s.plus31.RolePolicyRule.class))));
    }

    /**
     * A fluent builder for {@link org.cdk8s.plus31.Role}.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public static final class Builder implements software.amazon.jsii.Builder {
        /**
         * @return a new instance of {@link Builder}.
         * @param scope This parameter is required.
         * @param id This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        public static Builder create(final software.constructs.Construct scope, final java.lang.String id) {
            return new Builder(scope, id);
        }

        private final software.constructs.Construct scope;
        private final java.lang.String id;
        private org.cdk8s.plus31.RoleProps.Builder props;

        private Builder(final software.constructs.Construct scope, final java.lang.String id) {
            this.scope = scope;
            this.id = id;
        }

        /**
         * Metadata that all persisted resources must have, which includes all objects users must create.
         * 
    
         * @return {@code this}
         * @param metadata Metadata that all persisted resources must have, which includes all objects users must create. This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        public Builder metadata(final org.cdk8s.ApiObjectMetadata metadata) {
            this.props().metadata(metadata);
            return this;
        }

        /**
         * A list of rules the role should allow.
         * 
    
         * Default: []
         * 
    
         * @return {@code this}
         * @param rules A list of rules the role should allow. This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        public Builder rules(final java.util.List rules) {
            this.props().rules(rules);
            return this;
        }

        /**
         * @return a newly built instance of {@link org.cdk8s.plus31.Role}.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        @Override
        public org.cdk8s.plus31.Role build() {
            return new org.cdk8s.plus31.Role(
                this.scope,
                this.id,
                this.props != null ? this.props.build() : null
            );
        }

        private org.cdk8s.plus31.RoleProps.Builder props() {
            if (this.props == null) {
                this.props = new org.cdk8s.plus31.RoleProps.Builder();
            }
            return this.props;
        }
    }
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy