com.pulumi.azurenative.documentdb.inputs.ClusterResourcePropertiesArgs Maven / Gradle / Ivy
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azurenative.documentdb.inputs;
import com.pulumi.azurenative.documentdb.enums.AuthenticationMethod;
import com.pulumi.azurenative.documentdb.enums.ManagedCassandraProvisioningState;
import com.pulumi.azurenative.documentdb.inputs.CassandraErrorArgs;
import com.pulumi.azurenative.documentdb.inputs.CertificateArgs;
import com.pulumi.azurenative.documentdb.inputs.SeedNodeArgs;
import com.pulumi.core.Either;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Properties of a managed Cassandra cluster.
*
*/
public final class ClusterResourcePropertiesArgs extends com.pulumi.resources.ResourceArgs {
public static final ClusterResourcePropertiesArgs Empty = new ClusterResourcePropertiesArgs();
/**
* Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'.
*
*/
@Import(name="authenticationMethod")
private @Nullable Output> authenticationMethod;
/**
* @return Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'.
*
*/
public Optional>> authenticationMethod() {
return Optional.ofNullable(this.authenticationMethod);
}
/**
* Whether Cassandra audit logging is enabled
*
*/
@Import(name="cassandraAuditLoggingEnabled")
private @Nullable Output cassandraAuditLoggingEnabled;
/**
* @return Whether Cassandra audit logging is enabled
*
*/
public Optional> cassandraAuditLoggingEnabled() {
return Optional.ofNullable(this.cassandraAuditLoggingEnabled);
}
/**
* Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version.
*
*/
@Import(name="cassandraVersion")
private @Nullable Output cassandraVersion;
/**
* @return Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version.
*
*/
public Optional> cassandraVersion() {
return Optional.ofNullable(this.cassandraVersion);
}
/**
* List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property.
*
*/
@Import(name="clientCertificates")
private @Nullable Output> clientCertificates;
/**
* @return List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property.
*
*/
public Optional>> clientCertificates() {
return Optional.ofNullable(this.clientCertificates);
}
/**
* If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property.
*
*/
@Import(name="clusterNameOverride")
private @Nullable Output clusterNameOverride;
/**
* @return If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property.
*
*/
public Optional> clusterNameOverride() {
return Optional.ofNullable(this.clusterNameOverride);
}
/**
* Whether the cluster and associated data centers has been deallocated.
*
*/
@Import(name="deallocated")
private @Nullable Output deallocated;
/**
* @return Whether the cluster and associated data centers has been deallocated.
*
*/
public Optional> deallocated() {
return Optional.ofNullable(this.deallocated);
}
/**
* Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions/<subscription id>/resourceGroups/<resource group>/providers/Microsoft.Network/virtualNetworks/<virtual network>/subnets/<subnet>'
*
*/
@Import(name="delegatedManagementSubnetId")
private @Nullable Output delegatedManagementSubnetId;
/**
* @return Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions/<subscription id>/resourceGroups/<resource group>/providers/Microsoft.Network/virtualNetworks/<virtual network>/subnets/<subnet>'
*
*/
public Optional> delegatedManagementSubnetId() {
return Optional.ofNullable(this.delegatedManagementSubnetId);
}
/**
* List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property.
*
*/
@Import(name="externalGossipCertificates")
private @Nullable Output> externalGossipCertificates;
/**
* @return List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property.
*
*/
public Optional>> externalGossipCertificates() {
return Optional.ofNullable(this.externalGossipCertificates);
}
/**
* List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.
*
*/
@Import(name="externalSeedNodes")
private @Nullable Output> externalSeedNodes;
/**
* @return List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.
*
*/
public Optional>> externalSeedNodes() {
return Optional.ofNullable(this.externalSeedNodes);
}
/**
* (Deprecated) Number of hours to wait between taking a backup of the cluster.
*
*/
@Import(name="hoursBetweenBackups")
private @Nullable Output hoursBetweenBackups;
/**
* @return (Deprecated) Number of hours to wait between taking a backup of the cluster.
*
*/
public Optional> hoursBetweenBackups() {
return Optional.ofNullable(this.hoursBetweenBackups);
}
/**
* Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'.
*
*/
@Import(name="initialCassandraAdminPassword")
private @Nullable Output initialCassandraAdminPassword;
/**
* @return Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'.
*
*/
public Optional> initialCassandraAdminPassword() {
return Optional.ofNullable(this.initialCassandraAdminPassword);
}
/**
* Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached.
*
*/
@Import(name="prometheusEndpoint")
private @Nullable Output prometheusEndpoint;
/**
* @return Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached.
*
*/
public Optional> prometheusEndpoint() {
return Optional.ofNullable(this.prometheusEndpoint);
}
/**
* Error related to resource provisioning.
*
*/
@Import(name="provisionError")
private @Nullable Output provisionError;
/**
* @return Error related to resource provisioning.
*
*/
public Optional> provisionError() {
return Optional.ofNullable(this.provisionError);
}
/**
* The status of the resource at the time the operation was called.
*
*/
@Import(name="provisioningState")
private @Nullable Output> provisioningState;
/**
* @return The status of the resource at the time the operation was called.
*
*/
public Optional>> provisioningState() {
return Optional.ofNullable(this.provisioningState);
}
/**
* Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs.
*
*/
@Import(name="repairEnabled")
private @Nullable Output repairEnabled;
/**
* @return Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs.
*
*/
public Optional> repairEnabled() {
return Optional.ofNullable(this.repairEnabled);
}
/**
* To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup.
*
*/
@Import(name="restoreFromBackupId")
private @Nullable Output restoreFromBackupId;
/**
* @return To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup.
*
*/
public Optional> restoreFromBackupId() {
return Optional.ofNullable(this.restoreFromBackupId);
}
private ClusterResourcePropertiesArgs() {}
private ClusterResourcePropertiesArgs(ClusterResourcePropertiesArgs $) {
this.authenticationMethod = $.authenticationMethod;
this.cassandraAuditLoggingEnabled = $.cassandraAuditLoggingEnabled;
this.cassandraVersion = $.cassandraVersion;
this.clientCertificates = $.clientCertificates;
this.clusterNameOverride = $.clusterNameOverride;
this.deallocated = $.deallocated;
this.delegatedManagementSubnetId = $.delegatedManagementSubnetId;
this.externalGossipCertificates = $.externalGossipCertificates;
this.externalSeedNodes = $.externalSeedNodes;
this.hoursBetweenBackups = $.hoursBetweenBackups;
this.initialCassandraAdminPassword = $.initialCassandraAdminPassword;
this.prometheusEndpoint = $.prometheusEndpoint;
this.provisionError = $.provisionError;
this.provisioningState = $.provisioningState;
this.repairEnabled = $.repairEnabled;
this.restoreFromBackupId = $.restoreFromBackupId;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(ClusterResourcePropertiesArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private ClusterResourcePropertiesArgs $;
public Builder() {
$ = new ClusterResourcePropertiesArgs();
}
public Builder(ClusterResourcePropertiesArgs defaults) {
$ = new ClusterResourcePropertiesArgs(Objects.requireNonNull(defaults));
}
/**
* @param authenticationMethod Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'.
*
* @return builder
*
*/
public Builder authenticationMethod(@Nullable Output> authenticationMethod) {
$.authenticationMethod = authenticationMethod;
return this;
}
/**
* @param authenticationMethod Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'.
*
* @return builder
*
*/
public Builder authenticationMethod(Either authenticationMethod) {
return authenticationMethod(Output.of(authenticationMethod));
}
/**
* @param authenticationMethod Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'.
*
* @return builder
*
*/
public Builder authenticationMethod(String authenticationMethod) {
return authenticationMethod(Either.ofLeft(authenticationMethod));
}
/**
* @param authenticationMethod Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'.
*
* @return builder
*
*/
public Builder authenticationMethod(AuthenticationMethod authenticationMethod) {
return authenticationMethod(Either.ofRight(authenticationMethod));
}
/**
* @param cassandraAuditLoggingEnabled Whether Cassandra audit logging is enabled
*
* @return builder
*
*/
public Builder cassandraAuditLoggingEnabled(@Nullable Output cassandraAuditLoggingEnabled) {
$.cassandraAuditLoggingEnabled = cassandraAuditLoggingEnabled;
return this;
}
/**
* @param cassandraAuditLoggingEnabled Whether Cassandra audit logging is enabled
*
* @return builder
*
*/
public Builder cassandraAuditLoggingEnabled(Boolean cassandraAuditLoggingEnabled) {
return cassandraAuditLoggingEnabled(Output.of(cassandraAuditLoggingEnabled));
}
/**
* @param cassandraVersion Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version.
*
* @return builder
*
*/
public Builder cassandraVersion(@Nullable Output cassandraVersion) {
$.cassandraVersion = cassandraVersion;
return this;
}
/**
* @param cassandraVersion Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version.
*
* @return builder
*
*/
public Builder cassandraVersion(String cassandraVersion) {
return cassandraVersion(Output.of(cassandraVersion));
}
/**
* @param clientCertificates List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property.
*
* @return builder
*
*/
public Builder clientCertificates(@Nullable Output> clientCertificates) {
$.clientCertificates = clientCertificates;
return this;
}
/**
* @param clientCertificates List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property.
*
* @return builder
*
*/
public Builder clientCertificates(List clientCertificates) {
return clientCertificates(Output.of(clientCertificates));
}
/**
* @param clientCertificates List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property.
*
* @return builder
*
*/
public Builder clientCertificates(CertificateArgs... clientCertificates) {
return clientCertificates(List.of(clientCertificates));
}
/**
* @param clusterNameOverride If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property.
*
* @return builder
*
*/
public Builder clusterNameOverride(@Nullable Output clusterNameOverride) {
$.clusterNameOverride = clusterNameOverride;
return this;
}
/**
* @param clusterNameOverride If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property.
*
* @return builder
*
*/
public Builder clusterNameOverride(String clusterNameOverride) {
return clusterNameOverride(Output.of(clusterNameOverride));
}
/**
* @param deallocated Whether the cluster and associated data centers has been deallocated.
*
* @return builder
*
*/
public Builder deallocated(@Nullable Output deallocated) {
$.deallocated = deallocated;
return this;
}
/**
* @param deallocated Whether the cluster and associated data centers has been deallocated.
*
* @return builder
*
*/
public Builder deallocated(Boolean deallocated) {
return deallocated(Output.of(deallocated));
}
/**
* @param delegatedManagementSubnetId Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions/<subscription id>/resourceGroups/<resource group>/providers/Microsoft.Network/virtualNetworks/<virtual network>/subnets/<subnet>'
*
* @return builder
*
*/
public Builder delegatedManagementSubnetId(@Nullable Output delegatedManagementSubnetId) {
$.delegatedManagementSubnetId = delegatedManagementSubnetId;
return this;
}
/**
* @param delegatedManagementSubnetId Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions/<subscription id>/resourceGroups/<resource group>/providers/Microsoft.Network/virtualNetworks/<virtual network>/subnets/<subnet>'
*
* @return builder
*
*/
public Builder delegatedManagementSubnetId(String delegatedManagementSubnetId) {
return delegatedManagementSubnetId(Output.of(delegatedManagementSubnetId));
}
/**
* @param externalGossipCertificates List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property.
*
* @return builder
*
*/
public Builder externalGossipCertificates(@Nullable Output> externalGossipCertificates) {
$.externalGossipCertificates = externalGossipCertificates;
return this;
}
/**
* @param externalGossipCertificates List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property.
*
* @return builder
*
*/
public Builder externalGossipCertificates(List externalGossipCertificates) {
return externalGossipCertificates(Output.of(externalGossipCertificates));
}
/**
* @param externalGossipCertificates List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property.
*
* @return builder
*
*/
public Builder externalGossipCertificates(CertificateArgs... externalGossipCertificates) {
return externalGossipCertificates(List.of(externalGossipCertificates));
}
/**
* @param externalSeedNodes List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.
*
* @return builder
*
*/
public Builder externalSeedNodes(@Nullable Output> externalSeedNodes) {
$.externalSeedNodes = externalSeedNodes;
return this;
}
/**
* @param externalSeedNodes List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.
*
* @return builder
*
*/
public Builder externalSeedNodes(List externalSeedNodes) {
return externalSeedNodes(Output.of(externalSeedNodes));
}
/**
* @param externalSeedNodes List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.
*
* @return builder
*
*/
public Builder externalSeedNodes(SeedNodeArgs... externalSeedNodes) {
return externalSeedNodes(List.of(externalSeedNodes));
}
/**
* @param hoursBetweenBackups (Deprecated) Number of hours to wait between taking a backup of the cluster.
*
* @return builder
*
*/
public Builder hoursBetweenBackups(@Nullable Output hoursBetweenBackups) {
$.hoursBetweenBackups = hoursBetweenBackups;
return this;
}
/**
* @param hoursBetweenBackups (Deprecated) Number of hours to wait between taking a backup of the cluster.
*
* @return builder
*
*/
public Builder hoursBetweenBackups(Integer hoursBetweenBackups) {
return hoursBetweenBackups(Output.of(hoursBetweenBackups));
}
/**
* @param initialCassandraAdminPassword Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'.
*
* @return builder
*
*/
public Builder initialCassandraAdminPassword(@Nullable Output initialCassandraAdminPassword) {
$.initialCassandraAdminPassword = initialCassandraAdminPassword;
return this;
}
/**
* @param initialCassandraAdminPassword Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'.
*
* @return builder
*
*/
public Builder initialCassandraAdminPassword(String initialCassandraAdminPassword) {
return initialCassandraAdminPassword(Output.of(initialCassandraAdminPassword));
}
/**
* @param prometheusEndpoint Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached.
*
* @return builder
*
*/
public Builder prometheusEndpoint(@Nullable Output prometheusEndpoint) {
$.prometheusEndpoint = prometheusEndpoint;
return this;
}
/**
* @param prometheusEndpoint Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached.
*
* @return builder
*
*/
public Builder prometheusEndpoint(SeedNodeArgs prometheusEndpoint) {
return prometheusEndpoint(Output.of(prometheusEndpoint));
}
/**
* @param provisionError Error related to resource provisioning.
*
* @return builder
*
*/
public Builder provisionError(@Nullable Output provisionError) {
$.provisionError = provisionError;
return this;
}
/**
* @param provisionError Error related to resource provisioning.
*
* @return builder
*
*/
public Builder provisionError(CassandraErrorArgs provisionError) {
return provisionError(Output.of(provisionError));
}
/**
* @param provisioningState The status of the resource at the time the operation was called.
*
* @return builder
*
*/
public Builder provisioningState(@Nullable Output> provisioningState) {
$.provisioningState = provisioningState;
return this;
}
/**
* @param provisioningState The status of the resource at the time the operation was called.
*
* @return builder
*
*/
public Builder provisioningState(Either provisioningState) {
return provisioningState(Output.of(provisioningState));
}
/**
* @param provisioningState The status of the resource at the time the operation was called.
*
* @return builder
*
*/
public Builder provisioningState(String provisioningState) {
return provisioningState(Either.ofLeft(provisioningState));
}
/**
* @param provisioningState The status of the resource at the time the operation was called.
*
* @return builder
*
*/
public Builder provisioningState(ManagedCassandraProvisioningState provisioningState) {
return provisioningState(Either.ofRight(provisioningState));
}
/**
* @param repairEnabled Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs.
*
* @return builder
*
*/
public Builder repairEnabled(@Nullable Output repairEnabled) {
$.repairEnabled = repairEnabled;
return this;
}
/**
* @param repairEnabled Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs.
*
* @return builder
*
*/
public Builder repairEnabled(Boolean repairEnabled) {
return repairEnabled(Output.of(repairEnabled));
}
/**
* @param restoreFromBackupId To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup.
*
* @return builder
*
*/
public Builder restoreFromBackupId(@Nullable Output restoreFromBackupId) {
$.restoreFromBackupId = restoreFromBackupId;
return this;
}
/**
* @param restoreFromBackupId To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup.
*
* @return builder
*
*/
public Builder restoreFromBackupId(String restoreFromBackupId) {
return restoreFromBackupId(Output.of(restoreFromBackupId));
}
public ClusterResourcePropertiesArgs build() {
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy