org.mongodb.awscdk.resources.mongodbatlas.CfnApiKeyProps Maven / Gradle / Ivy
Show all versions of awscdk-resources-mongodbatlas Show documentation
package org.mongodb.awscdk.resources.mongodbatlas;
/**
* Creates one API key for the specified organization.
*
* An organization API key grants programmatic access to an organization.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.101.0 (build b95fe5d)", date = "2024-07-30T09:54:28.895Z")
@software.amazon.jsii.Jsii(module = org.mongodb.awscdk.resources.mongodbatlas.$Module.class, fqn = "awscdk-resources-mongodbatlas.CfnApiKeyProps")
@software.amazon.jsii.Jsii.Proxy(CfnApiKeyProps.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public interface CfnApiKeyProps extends software.amazon.jsii.JsiiSerializable {
/**
* Name of the AWS Secrets Manager secret that stores the API key Details.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.String getAwsSecretName();
/**
* Purpose or explanation provided when someone created this organization API key.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.String getDescription();
/**
* Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
*
* Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.String getOrgId();
/**
* ARN of the AWS Secrets Manager secret that stores the API key Details.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getAwsSecretArn() {
return null;
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable org.mongodb.awscdk.resources.mongodbatlas.ListOptions getListOptions() {
return null;
}
/**
* Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getProfile() {
return null;
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.util.List getProjectAssignments() {
return null;
}
/**
* List of roles to grant this API key.
*
* If you provide this list, provide a minimum of one role and ensure each role applies to this organization.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.util.List getRoles() {
return null;
}
/**
* @return a {@link Builder} of {@link CfnApiKeyProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link CfnApiKeyProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.String awsSecretName;
java.lang.String description;
java.lang.String orgId;
java.lang.String awsSecretArn;
org.mongodb.awscdk.resources.mongodbatlas.ListOptions listOptions;
java.lang.String profile;
java.util.List projectAssignments;
java.util.List roles;
/**
* Sets the value of {@link CfnApiKeyProps#getAwsSecretName}
* @param awsSecretName Name of the AWS Secrets Manager secret that stores the API key Details. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder awsSecretName(java.lang.String awsSecretName) {
this.awsSecretName = awsSecretName;
return this;
}
/**
* Sets the value of {@link CfnApiKeyProps#getDescription}
* @param description Purpose or explanation provided when someone created this organization API key. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder description(java.lang.String description) {
this.description = description;
return this;
}
/**
* Sets the value of {@link CfnApiKeyProps#getOrgId}
* @param orgId Unique 24-hexadecimal digit string that identifies the organization that contains your projects. This parameter is required.
* Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder orgId(java.lang.String orgId) {
this.orgId = orgId;
return this;
}
/**
* Sets the value of {@link CfnApiKeyProps#getAwsSecretArn}
* @param awsSecretArn ARN of the AWS Secrets Manager secret that stores the API key Details.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder awsSecretArn(java.lang.String awsSecretArn) {
this.awsSecretArn = awsSecretArn;
return this;
}
/**
* Sets the value of {@link CfnApiKeyProps#getListOptions}
* @param listOptions the value to be set.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder listOptions(org.mongodb.awscdk.resources.mongodbatlas.ListOptions listOptions) {
this.listOptions = listOptions;
return this;
}
/**
* Sets the value of {@link CfnApiKeyProps#getProfile}
* @param profile Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder profile(java.lang.String profile) {
this.profile = profile;
return this;
}
/**
* Sets the value of {@link CfnApiKeyProps#getProjectAssignments}
* @param projectAssignments the value to be set.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@SuppressWarnings("unchecked")
public Builder projectAssignments(java.util.List projectAssignments) {
this.projectAssignments = (java.util.List)projectAssignments;
return this;
}
/**
* Sets the value of {@link CfnApiKeyProps#getRoles}
* @param roles List of roles to grant this API key.
* If you provide this list, provide a minimum of one role and ensure each role applies to this organization.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder roles(java.util.List roles) {
this.roles = roles;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link CfnApiKeyProps}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public CfnApiKeyProps build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link CfnApiKeyProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnApiKeyProps {
private final java.lang.String awsSecretName;
private final java.lang.String description;
private final java.lang.String orgId;
private final java.lang.String awsSecretArn;
private final org.mongodb.awscdk.resources.mongodbatlas.ListOptions listOptions;
private final java.lang.String profile;
private final java.util.List projectAssignments;
private final java.util.List roles;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.awsSecretName = software.amazon.jsii.Kernel.get(this, "awsSecretName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.description = software.amazon.jsii.Kernel.get(this, "description", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.orgId = software.amazon.jsii.Kernel.get(this, "orgId", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.awsSecretArn = software.amazon.jsii.Kernel.get(this, "awsSecretArn", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.listOptions = software.amazon.jsii.Kernel.get(this, "listOptions", software.amazon.jsii.NativeType.forClass(org.mongodb.awscdk.resources.mongodbatlas.ListOptions.class));
this.profile = software.amazon.jsii.Kernel.get(this, "profile", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.projectAssignments = software.amazon.jsii.Kernel.get(this, "projectAssignments", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(org.mongodb.awscdk.resources.mongodbatlas.ProjectAssignment.class)));
this.roles = software.amazon.jsii.Kernel.get(this, "roles", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class)));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
@SuppressWarnings("unchecked")
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.awsSecretName = java.util.Objects.requireNonNull(builder.awsSecretName, "awsSecretName is required");
this.description = java.util.Objects.requireNonNull(builder.description, "description is required");
this.orgId = java.util.Objects.requireNonNull(builder.orgId, "orgId is required");
this.awsSecretArn = builder.awsSecretArn;
this.listOptions = builder.listOptions;
this.profile = builder.profile;
this.projectAssignments = (java.util.List)builder.projectAssignments;
this.roles = builder.roles;
}
@Override
public final java.lang.String getAwsSecretName() {
return this.awsSecretName;
}
@Override
public final java.lang.String getDescription() {
return this.description;
}
@Override
public final java.lang.String getOrgId() {
return this.orgId;
}
@Override
public final java.lang.String getAwsSecretArn() {
return this.awsSecretArn;
}
@Override
public final org.mongodb.awscdk.resources.mongodbatlas.ListOptions getListOptions() {
return this.listOptions;
}
@Override
public final java.lang.String getProfile() {
return this.profile;
}
@Override
public final java.util.List getProjectAssignments() {
return this.projectAssignments;
}
@Override
public final java.util.List getRoles() {
return this.roles;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
data.set("awsSecretName", om.valueToTree(this.getAwsSecretName()));
data.set("description", om.valueToTree(this.getDescription()));
data.set("orgId", om.valueToTree(this.getOrgId()));
if (this.getAwsSecretArn() != null) {
data.set("awsSecretArn", om.valueToTree(this.getAwsSecretArn()));
}
if (this.getListOptions() != null) {
data.set("listOptions", om.valueToTree(this.getListOptions()));
}
if (this.getProfile() != null) {
data.set("profile", om.valueToTree(this.getProfile()));
}
if (this.getProjectAssignments() != null) {
data.set("projectAssignments", om.valueToTree(this.getProjectAssignments()));
}
if (this.getRoles() != null) {
data.set("roles", om.valueToTree(this.getRoles()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("awscdk-resources-mongodbatlas.CfnApiKeyProps"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
CfnApiKeyProps.Jsii$Proxy that = (CfnApiKeyProps.Jsii$Proxy) o;
if (!awsSecretName.equals(that.awsSecretName)) return false;
if (!description.equals(that.description)) return false;
if (!orgId.equals(that.orgId)) return false;
if (this.awsSecretArn != null ? !this.awsSecretArn.equals(that.awsSecretArn) : that.awsSecretArn != null) return false;
if (this.listOptions != null ? !this.listOptions.equals(that.listOptions) : that.listOptions != null) return false;
if (this.profile != null ? !this.profile.equals(that.profile) : that.profile != null) return false;
if (this.projectAssignments != null ? !this.projectAssignments.equals(that.projectAssignments) : that.projectAssignments != null) return false;
return this.roles != null ? this.roles.equals(that.roles) : that.roles == null;
}
@Override
public final int hashCode() {
int result = this.awsSecretName.hashCode();
result = 31 * result + (this.description.hashCode());
result = 31 * result + (this.orgId.hashCode());
result = 31 * result + (this.awsSecretArn != null ? this.awsSecretArn.hashCode() : 0);
result = 31 * result + (this.listOptions != null ? this.listOptions.hashCode() : 0);
result = 31 * result + (this.profile != null ? this.profile.hashCode() : 0);
result = 31 * result + (this.projectAssignments != null ? this.projectAssignments.hashCode() : 0);
result = 31 * result + (this.roles != null ? this.roles.hashCode() : 0);
return result;
}
}
}