
org.cdk8s.plus31.SshAuthSecret Maven / Gradle / Ivy
package org.cdk8s.plus31;
/**
* Create a secret for ssh authentication.
*
* @see https://kubernetes.io/docs/concepts/configuration/secret/#ssh-authentication-secrets
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.104.0 (build e79254c)", date = "2024-10-12T12:14:17.457Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Jsii(module = org.cdk8s.plus31.$Module.class, fqn = "cdk8s-plus-31.SshAuthSecret")
public class SshAuthSecret extends org.cdk8s.plus31.Secret {
protected SshAuthSecret(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected SshAuthSecret(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* @param scope This parameter is required.
* @param id This parameter is required.
* @param props This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public SshAuthSecret(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull org.cdk8s.plus31.SshAuthSecretProps 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"), java.util.Objects.requireNonNull(props, "props is required") });
}
/**
* A fluent builder for {@link org.cdk8s.plus31.SshAuthSecret}.
*/
@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 final org.cdk8s.plus31.SshAuthSecretProps.Builder props;
private Builder(final software.constructs.Construct scope, final java.lang.String id) {
this.scope = scope;
this.id = id;
this.props = new org.cdk8s.plus31.SshAuthSecretProps.Builder();
}
/**
* 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;
}
/**
* If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified).
*
* If not set to true, the field can be modified at any time.
*
* Default: false
*
* @return {@code this}
* @param immutable If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder immutable(final java.lang.Boolean immutable) {
this.props.immutable(immutable);
return this;
}
/**
* The SSH private key to use.
*
* @return {@code this}
* @param sshPrivateKey The SSH private key to use. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder sshPrivateKey(final java.lang.String sshPrivateKey) {
this.props.sshPrivateKey(sshPrivateKey);
return this;
}
/**
* @return a newly built instance of {@link org.cdk8s.plus31.SshAuthSecret}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public org.cdk8s.plus31.SshAuthSecret build() {
return new org.cdk8s.plus31.SshAuthSecret(
this.scope,
this.id,
this.props.build()
);
}
}
}