Interface ParamRefV1Alpha1
-
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
ParamRefV1Alpha1.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)", date="2024-08-03T12:13:25.837Z") @Stability(Stable) public interface ParamRefV1Alpha1 extends software.amazon.jsii.JsiiSerializable
ParamRef describes how to locate the params to be used as input to expressions of rules applied by a policy binding.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classParamRefV1Alpha1.BuilderA builder forParamRefV1Alpha1static classParamRefV1Alpha1.Jsii$ProxyAn implementation forParamRefV1Alpha1
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static ParamRefV1Alpha1.Builderbuilder()default StringgetName()nameis the name of the resource being referenced.default StringgetNamespace()namespace is the namespace of the referenced resource.default StringgetParameterNotFoundAction()parameterNotFoundActioncontrols the behavior of the binding when the resource exists, and name or selector is valid, but there are no parameters matched by the binding.default LabelSelectorgetSelector()selector can be used to match multiple param objects based on their labels.
-
-
-
Method Detail
-
getName
@Stability(Stable) @Nullable default String getName()
nameis the name of the resource being referenced.nameandselectorare mutually exclusive properties. If one is set, the other must be unset.
-
getNamespace
@Stability(Stable) @Nullable default String getNamespace()
namespace is the namespace of the referenced resource.Allows limiting the search for params to a specific namespace. Applies to both
nameandselectorfields.A per-namespace parameter may be used by specifying a namespace-scoped
paramKindin the policy and leaving this field empty.- If
paramKindis cluster-scoped, this field MUST be unset. Setting this field results in a configuration error. - If
paramKindis namespace-scoped, the namespace of the object being evaluated for admission will be used when this field is left unset. Take care that if this is left empty the binding must not match any cluster-scoped resources, which will result in an error.
- If
-
getParameterNotFoundAction
@Stability(Stable) @Nullable default String getParameterNotFoundAction()
parameterNotFoundActioncontrols the behavior of the binding when the resource exists, and name or selector is valid, but there are no parameters matched by the binding.If the value is set to
Allow, then no matched parameters will be treated as successful validation by the binding. If set toDeny, then no matched parameters will be subject to thefailurePolicyof the policy.Allowed values are
AlloworDenyDefault toDenyDefault: Deny`
-
getSelector
@Stability(Stable) @Nullable default LabelSelector getSelector()
selector can be used to match multiple param objects based on their labels.Supply selector: {} to match all resources of the ParamKind.
If multiple params are found, they are all evaluated with the policy expressions and the results are ANDed together.
One of
nameorselectormust be set, butnameandselectorare mutually exclusive properties. If one is set, the other must be unset.
-
builder
@Stability(Stable) static ParamRefV1Alpha1.Builder builder()
- Returns:
- a
ParamRefV1Alpha1.BuilderofParamRefV1Alpha1
-
-