com.pulumi.aws.rds.inputs.ProxyState Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
// *** 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.aws.rds.inputs;
import com.pulumi.aws.rds.inputs.ProxyAuthArgs;
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.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class ProxyState extends com.pulumi.resources.ResourceArgs {
public static final ProxyState Empty = new ProxyState();
/**
* The Amazon Resource Name (ARN) for the proxy.
*
*/
@Import(name="arn")
private @Nullable Output arn;
/**
* @return The Amazon Resource Name (ARN) for the proxy.
*
*/
public Optional> arn() {
return Optional.ofNullable(this.arn);
}
/**
* Configuration block(s) with authorization mechanisms to connect to the associated instances or clusters. Described below.
*
*/
@Import(name="auths")
private @Nullable Output> auths;
/**
* @return Configuration block(s) with authorization mechanisms to connect to the associated instances or clusters. Described below.
*
*/
public Optional>> auths() {
return Optional.ofNullable(this.auths);
}
/**
* Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
*
*/
@Import(name="debugLogging")
private @Nullable Output debugLogging;
/**
* @return Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
*
*/
public Optional> debugLogging() {
return Optional.ofNullable(this.debugLogging);
}
/**
* The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
*
*/
@Import(name="endpoint")
private @Nullable Output endpoint;
/**
* @return The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
*
*/
public Optional> endpoint() {
return Optional.ofNullable(this.endpoint);
}
/**
* The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify `MYSQL`. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify `POSTGRESQL`. For RDS for Microsoft SQL Server, specify `SQLSERVER`. Valid values are `MYSQL`, `POSTGRESQL`, and `SQLSERVER`.
*
*/
@Import(name="engineFamily")
private @Nullable Output engineFamily;
/**
* @return The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify `MYSQL`. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify `POSTGRESQL`. For RDS for Microsoft SQL Server, specify `SQLSERVER`. Valid values are `MYSQL`, `POSTGRESQL`, and `SQLSERVER`.
*
*/
public Optional> engineFamily() {
return Optional.ofNullable(this.engineFamily);
}
/**
* The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
*
*/
@Import(name="idleClientTimeout")
private @Nullable Output idleClientTimeout;
/**
* @return The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
*
*/
public Optional> idleClientTimeout() {
return Optional.ofNullable(this.idleClientTimeout);
}
/**
* The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
*
*/
@Import(name="name")
private @Nullable Output name;
/**
* @return The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
*
*/
public Optional> name() {
return Optional.ofNullable(this.name);
}
/**
* A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.
*
*/
@Import(name="requireTls")
private @Nullable Output requireTls;
/**
* @return A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.
*
*/
public Optional> requireTls() {
return Optional.ofNullable(this.requireTls);
}
/**
* The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
*
*/
@Import(name="roleArn")
private @Nullable Output roleArn;
/**
* @return The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
*
*/
public Optional> roleArn() {
return Optional.ofNullable(this.roleArn);
}
/**
* A mapping of tags to assign to the resource. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
*/
@Import(name="tags")
private @Nullable Output> tags;
/**
* @return A mapping of tags to assign to the resource. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
*/
public Optional>> tags() {
return Optional.ofNullable(this.tags);
}
/**
* A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
@Import(name="tagsAll")
private @Nullable Output> tagsAll;
/**
* @return A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
public Optional>> tagsAll() {
return Optional.ofNullable(this.tagsAll);
}
/**
* One or more VPC security group IDs to associate with the new proxy.
*
*/
@Import(name="vpcSecurityGroupIds")
private @Nullable Output> vpcSecurityGroupIds;
/**
* @return One or more VPC security group IDs to associate with the new proxy.
*
*/
public Optional>> vpcSecurityGroupIds() {
return Optional.ofNullable(this.vpcSecurityGroupIds);
}
/**
* One or more VPC subnet IDs to associate with the new proxy.
*
*/
@Import(name="vpcSubnetIds")
private @Nullable Output> vpcSubnetIds;
/**
* @return One or more VPC subnet IDs to associate with the new proxy.
*
*/
public Optional>> vpcSubnetIds() {
return Optional.ofNullable(this.vpcSubnetIds);
}
private ProxyState() {}
private ProxyState(ProxyState $) {
this.arn = $.arn;
this.auths = $.auths;
this.debugLogging = $.debugLogging;
this.endpoint = $.endpoint;
this.engineFamily = $.engineFamily;
this.idleClientTimeout = $.idleClientTimeout;
this.name = $.name;
this.requireTls = $.requireTls;
this.roleArn = $.roleArn;
this.tags = $.tags;
this.tagsAll = $.tagsAll;
this.vpcSecurityGroupIds = $.vpcSecurityGroupIds;
this.vpcSubnetIds = $.vpcSubnetIds;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(ProxyState defaults) {
return new Builder(defaults);
}
public static final class Builder {
private ProxyState $;
public Builder() {
$ = new ProxyState();
}
public Builder(ProxyState defaults) {
$ = new ProxyState(Objects.requireNonNull(defaults));
}
/**
* @param arn The Amazon Resource Name (ARN) for the proxy.
*
* @return builder
*
*/
public Builder arn(@Nullable Output arn) {
$.arn = arn;
return this;
}
/**
* @param arn The Amazon Resource Name (ARN) for the proxy.
*
* @return builder
*
*/
public Builder arn(String arn) {
return arn(Output.of(arn));
}
/**
* @param auths Configuration block(s) with authorization mechanisms to connect to the associated instances or clusters. Described below.
*
* @return builder
*
*/
public Builder auths(@Nullable Output> auths) {
$.auths = auths;
return this;
}
/**
* @param auths Configuration block(s) with authorization mechanisms to connect to the associated instances or clusters. Described below.
*
* @return builder
*
*/
public Builder auths(List auths) {
return auths(Output.of(auths));
}
/**
* @param auths Configuration block(s) with authorization mechanisms to connect to the associated instances or clusters. Described below.
*
* @return builder
*
*/
public Builder auths(ProxyAuthArgs... auths) {
return auths(List.of(auths));
}
/**
* @param debugLogging Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
*
* @return builder
*
*/
public Builder debugLogging(@Nullable Output debugLogging) {
$.debugLogging = debugLogging;
return this;
}
/**
* @param debugLogging Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
*
* @return builder
*
*/
public Builder debugLogging(Boolean debugLogging) {
return debugLogging(Output.of(debugLogging));
}
/**
* @param endpoint The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
*
* @return builder
*
*/
public Builder endpoint(@Nullable Output endpoint) {
$.endpoint = endpoint;
return this;
}
/**
* @param endpoint The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
*
* @return builder
*
*/
public Builder endpoint(String endpoint) {
return endpoint(Output.of(endpoint));
}
/**
* @param engineFamily The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify `MYSQL`. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify `POSTGRESQL`. For RDS for Microsoft SQL Server, specify `SQLSERVER`. Valid values are `MYSQL`, `POSTGRESQL`, and `SQLSERVER`.
*
* @return builder
*
*/
public Builder engineFamily(@Nullable Output engineFamily) {
$.engineFamily = engineFamily;
return this;
}
/**
* @param engineFamily The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify `MYSQL`. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify `POSTGRESQL`. For RDS for Microsoft SQL Server, specify `SQLSERVER`. Valid values are `MYSQL`, `POSTGRESQL`, and `SQLSERVER`.
*
* @return builder
*
*/
public Builder engineFamily(String engineFamily) {
return engineFamily(Output.of(engineFamily));
}
/**
* @param idleClientTimeout The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
*
* @return builder
*
*/
public Builder idleClientTimeout(@Nullable Output idleClientTimeout) {
$.idleClientTimeout = idleClientTimeout;
return this;
}
/**
* @param idleClientTimeout The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
*
* @return builder
*
*/
public Builder idleClientTimeout(Integer idleClientTimeout) {
return idleClientTimeout(Output.of(idleClientTimeout));
}
/**
* @param name The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
*
* @return builder
*
*/
public Builder name(@Nullable Output name) {
$.name = name;
return this;
}
/**
* @param name The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
*
* @return builder
*
*/
public Builder name(String name) {
return name(Output.of(name));
}
/**
* @param requireTls A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.
*
* @return builder
*
*/
public Builder requireTls(@Nullable Output requireTls) {
$.requireTls = requireTls;
return this;
}
/**
* @param requireTls A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.
*
* @return builder
*
*/
public Builder requireTls(Boolean requireTls) {
return requireTls(Output.of(requireTls));
}
/**
* @param roleArn The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
*
* @return builder
*
*/
public Builder roleArn(@Nullable Output roleArn) {
$.roleArn = roleArn;
return this;
}
/**
* @param roleArn The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
*
* @return builder
*
*/
public Builder roleArn(String roleArn) {
return roleArn(Output.of(roleArn));
}
/**
* @param tags A mapping of tags to assign to the resource. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
* @return builder
*
*/
public Builder tags(@Nullable Output> tags) {
$.tags = tags;
return this;
}
/**
* @param tags A mapping of tags to assign to the resource. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
* @return builder
*
*/
public Builder tags(Map tags) {
return tags(Output.of(tags));
}
/**
* @param tagsAll A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @return builder
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
public Builder tagsAll(@Nullable Output> tagsAll) {
$.tagsAll = tagsAll;
return this;
}
/**
* @param tagsAll A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @return builder
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
public Builder tagsAll(Map tagsAll) {
return tagsAll(Output.of(tagsAll));
}
/**
* @param vpcSecurityGroupIds One or more VPC security group IDs to associate with the new proxy.
*
* @return builder
*
*/
public Builder vpcSecurityGroupIds(@Nullable Output> vpcSecurityGroupIds) {
$.vpcSecurityGroupIds = vpcSecurityGroupIds;
return this;
}
/**
* @param vpcSecurityGroupIds One or more VPC security group IDs to associate with the new proxy.
*
* @return builder
*
*/
public Builder vpcSecurityGroupIds(List vpcSecurityGroupIds) {
return vpcSecurityGroupIds(Output.of(vpcSecurityGroupIds));
}
/**
* @param vpcSecurityGroupIds One or more VPC security group IDs to associate with the new proxy.
*
* @return builder
*
*/
public Builder vpcSecurityGroupIds(String... vpcSecurityGroupIds) {
return vpcSecurityGroupIds(List.of(vpcSecurityGroupIds));
}
/**
* @param vpcSubnetIds One or more VPC subnet IDs to associate with the new proxy.
*
* @return builder
*
*/
public Builder vpcSubnetIds(@Nullable Output> vpcSubnetIds) {
$.vpcSubnetIds = vpcSubnetIds;
return this;
}
/**
* @param vpcSubnetIds One or more VPC subnet IDs to associate with the new proxy.
*
* @return builder
*
*/
public Builder vpcSubnetIds(List vpcSubnetIds) {
return vpcSubnetIds(Output.of(vpcSubnetIds));
}
/**
* @param vpcSubnetIds One or more VPC subnet IDs to associate with the new proxy.
*
* @return builder
*
*/
public Builder vpcSubnetIds(String... vpcSubnetIds) {
return vpcSubnetIds(List.of(vpcSubnetIds));
}
public ProxyState build() {
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy