org.mongodb.awscdk.resources.mongodbatlas.CfnPrivateEndpointAws Maven / Gradle / Ivy
Show all versions of awscdk-resources-mongodbatlas Show documentation
package org.mongodb.awscdk.resources.mongodbatlas;
/**
* A CloudFormation MongoDB::Atlas::PrivateEndpointAWS.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.101.0 (build b95fe5d)", date = "2024-07-30T09:54:28.959Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Jsii(module = org.mongodb.awscdk.resources.mongodbatlas.$Module.class, fqn = "awscdk-resources-mongodbatlas.CfnPrivateEndpointAws")
public class CfnPrivateEndpointAws extends software.amazon.awscdk.CfnResource {
protected CfnPrivateEndpointAws(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected CfnPrivateEndpointAws(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
static {
CFN_RESOURCE_TYPE_NAME = software.amazon.jsii.JsiiObject.jsiiStaticGet(org.mongodb.awscdk.resources.mongodbatlas.CfnPrivateEndpointAws.class, "CFN_RESOURCE_TYPE_NAME", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Create a new MongoDB::Atlas::PrivateEndpointAWS.
*
* @param scope
- scope in which this resource is defined.
This parameter is required.
* @param id - scoped id of the resource.
This parameter is required.
* @param props - resource properties.
This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public CfnPrivateEndpointAws(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull org.mongodb.awscdk.resources.mongodbatlas.CfnPrivateEndpointAwsProps 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") });
}
/**
* The CloudFormation resource type name for this resource class.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final static java.lang.String CFN_RESOURCE_TYPE_NAME;
/**
* Resource props.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull org.mongodb.awscdk.resources.mongodbatlas.CfnPrivateEndpointAwsProps getProps() {
return software.amazon.jsii.Kernel.get(this, "props", software.amazon.jsii.NativeType.forClass(org.mongodb.awscdk.resources.mongodbatlas.CfnPrivateEndpointAwsProps.class));
}
/**
* A fluent builder for {@link org.mongodb.awscdk.resources.mongodbatlas.CfnPrivateEndpointAws}.
*/
@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 - scope in which this resource is defined.
This parameter is required.
* @param id - scoped id of the resource.
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.mongodb.awscdk.resources.mongodbatlas.CfnPrivateEndpointAwsProps.Builder props;
private Builder(final software.constructs.Construct scope, final java.lang.String id) {
this.scope = scope;
this.id = id;
this.props = new org.mongodb.awscdk.resources.mongodbatlas.CfnPrivateEndpointAwsProps.Builder();
}
/**
* Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint.
*
* @return {@code this}
* @param endpointServiceId Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder endpointServiceId(final java.lang.String endpointServiceId) {
this.props.endpointServiceId(endpointServiceId);
return this;
}
/**
* Unique 24-hexadecimal digit string that identifies your project.
*
* @return {@code this}
* @param projectId Unique 24-hexadecimal digit string that identifies your project. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder projectId(final java.lang.String projectId) {
this.props.projectId(projectId);
return this;
}
/**
* State of the Amazon Web Service PrivateLink connection when MongoDB Cloud received this request.
*
* @return {@code this}
* @param connectionStatus State of the Amazon Web Service PrivateLink connection when MongoDB Cloud received this request. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder connectionStatus(final java.lang.String connectionStatus) {
this.props.connectionStatus(connectionStatus);
return this;
}
/**
* If this proper is set to TRUE, the cloud formation resource will return success Only if the private connection is Succeeded.
*
* @return {@code this}
* @param enforceConnectionSuccess If this proper is set to TRUE, the cloud formation resource will return success Only if the private connection is Succeeded. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder enforceConnectionSuccess(final java.lang.Boolean enforceConnectionSuccess) {
this.props.enforceConnectionSuccess(enforceConnectionSuccess);
return this;
}
/**
* Error message returned when requesting private connection resource.
*
* The resource returns null if the request succeeded.
*
* @return {@code this}
* @param errorMessage Error message returned when requesting private connection resource. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder errorMessage(final java.lang.String errorMessage) {
this.props.errorMessage(errorMessage);
return this;
}
/**
* Unique string that identifies the private endpoint.
*
* for AWS is the VPC endpoint ID, example: vpce-xxxxxxxx
*
* @return {@code this}
* @param id Unique string that identifies the private endpoint. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder id(final java.lang.String id) {
this.props.id(id);
return this;
}
/**
* The profile is defined in AWS Secret manager.
*
* See Secret Manager Profile setup
*
* @return {@code this}
* @param profile The profile is defined in AWS Secret manager. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder profile(final java.lang.String profile) {
this.props.profile(profile);
return this;
}
/**
* @return a newly built instance of {@link org.mongodb.awscdk.resources.mongodbatlas.CfnPrivateEndpointAws}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public org.mongodb.awscdk.resources.mongodbatlas.CfnPrivateEndpointAws build() {
return new org.mongodb.awscdk.resources.mongodbatlas.CfnPrivateEndpointAws(
this.scope,
this.id,
this.props.build()
);
}
}
}