org.mongodb.awscdk.resources.mongodbatlas.CfnServerlessPrivateEndpoint Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of awscdk-resources-mongodbatlas Show documentation
MongoDB Atlas CDK Construct Library for AWS CloudFormation Resources
There is a newer version: 3.9.0
Show newest version
package org.mongodb.awscdk.resources.mongodbatlas;

/**
 * A CloudFormation MongoDB::Atlas::ServerlessPrivateEndpoint.
 */
@javax.annotation.Generated(value = "jsii-pacmak/1.101.0 (build b95fe5d)", date = "2024-07-30T09:54:28.980Z")
@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.CfnServerlessPrivateEndpoint")
public class CfnServerlessPrivateEndpoint extends software.amazon.awscdk.CfnResource {

    protected CfnServerlessPrivateEndpoint(final software.amazon.jsii.JsiiObjectRef objRef) {
        super(objRef);
    }

    protected CfnServerlessPrivateEndpoint(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
        super(initializationMode);
    }

    static {
        CFN_RESOURCE_TYPE_NAME = software.amazon.jsii.JsiiObject.jsiiStaticGet(org.mongodb.awscdk.resources.mongodbatlas.CfnServerlessPrivateEndpoint.class, "CFN_RESOURCE_TYPE_NAME", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
    }

    /**
     * Create a new MongoDB::Atlas::ServerlessPrivateEndpoint.
     * 
     * @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 CfnServerlessPrivateEndpoint(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.CfnServerlessPrivateEndpointProps 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;

    /**
     * Attribute MongoDB::Atlas::ServerlessPrivateEndpoint.AwsPrivateEndpointMetaData.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public @org.jetbrains.annotations.NotNull java.lang.String getAttrAwsPrivateEndpointMetaData() {
        return software.amazon.jsii.Kernel.get(this, "attrAwsPrivateEndpointMetaData", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
    }

    /**
     * Attribute MongoDB::Atlas::ServerlessPrivateEndpoint.EndpointServiceName.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public @org.jetbrains.annotations.NotNull java.lang.String getAttrEndpointServiceName() {
        return software.amazon.jsii.Kernel.get(this, "attrEndpointServiceName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
    }

    /**
     * Attribute MongoDB::Atlas::ServerlessPrivateEndpoint.ErrorMessage.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public @org.jetbrains.annotations.NotNull java.lang.String getAttrErrorMessage() {
        return software.amazon.jsii.Kernel.get(this, "attrErrorMessage", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
    }

    /**
     * Attribute MongoDB::Atlas::ServerlessPrivateEndpoint.Id.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public @org.jetbrains.annotations.NotNull java.lang.String getAttrId() {
        return software.amazon.jsii.Kernel.get(this, "attrId", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
    }

    /**
     * Attribute MongoDB::Atlas::ServerlessPrivateEndpoint.ProviderName.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public @org.jetbrains.annotations.NotNull java.lang.String getAttrProviderName() {
        return software.amazon.jsii.Kernel.get(this, "attrProviderName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
    }

    /**
     * Attribute MongoDB::Atlas::ServerlessPrivateEndpoint.Status.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public @org.jetbrains.annotations.NotNull java.lang.String getAttrStatus() {
        return software.amazon.jsii.Kernel.get(this, "attrStatus", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
    }

    /**
     * Resource props.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public @org.jetbrains.annotations.NotNull org.mongodb.awscdk.resources.mongodbatlas.CfnServerlessPrivateEndpointProps getProps() {
        return software.amazon.jsii.Kernel.get(this, "props", software.amazon.jsii.NativeType.forClass(org.mongodb.awscdk.resources.mongodbatlas.CfnServerlessPrivateEndpointProps.class));
    }

    /**
     * A fluent builder for {@link org.mongodb.awscdk.resources.mongodbatlas.CfnServerlessPrivateEndpoint}.
     */
    @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.CfnServerlessPrivateEndpointProps.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.CfnServerlessPrivateEndpointProps.Builder();
        }

        /**
         * Human-readable label that identifies the serverless instance for which the tenant endpoint will be created.
         * 
         * @return {@code this}
         * @param instanceName Human-readable label that identifies the serverless instance for which the tenant endpoint will be created. This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        public Builder instanceName(final java.lang.String instanceName) {
            this.props.instanceName(instanceName);
            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;
        }

        /**
         * Properties used to configure Aws private endpoint.
         * 

         * @return {@code this}
         * @param awsPrivateEndpointConfigurationProperties Properties used to configure Aws private endpoint. This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        public Builder awsPrivateEndpointConfigurationProperties(final org.mongodb.awscdk.resources.mongodbatlas.AwsPrivateEndpointConfig awsPrivateEndpointConfigurationProperties) {
            this.props.awsPrivateEndpointConfigurationProperties(awsPrivateEndpointConfigurationProperties);
            return this;
        }

        /**
         * Unique string that identifies the private endpoint's network interface.
         * 

         * @return {@code this}
         * @param cloudProviderEndpointId Unique string that identifies the private endpoint's network interface. This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        public Builder cloudProviderEndpointId(final java.lang.String cloudProviderEndpointId) {
            this.props.cloudProviderEndpointId(cloudProviderEndpointId);
            return this;
        }

        /**
         * Human-readable comment associated with the private endpoint.
         * 

         * @return {@code this}
         * @param comment Human-readable comment associated with the private endpoint. This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        public Builder comment(final java.lang.String comment) {
            this.props.comment(comment);
            return this;
        }

        /**
         * If true the resource will create the aws private endpoint and assign the Endpoint ID.
         * 

         * @return {@code this}
         * @param createAndAssignAwsPrivateEndpoint If true the resource will create the aws private endpoint and assign the Endpoint ID. This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        public Builder createAndAssignAwsPrivateEndpoint(final java.lang.Boolean createAndAssignAwsPrivateEndpoint) {
            this.props.createAndAssignAwsPrivateEndpoint(createAndAssignAwsPrivateEndpoint);
            return this;
        }

        /**
         * IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.
         * 

         * @return {@code this}
         * @param privateEndpointIpAddress IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service. This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        public Builder privateEndpointIpAddress(final java.lang.String privateEndpointIpAddress) {
            this.props.privateEndpointIpAddress(privateEndpointIpAddress);
            return this;
        }

        /**
         * 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}
         * @param profile Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used. 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.CfnServerlessPrivateEndpoint}.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
        @Override
        public org.mongodb.awscdk.resources.mongodbatlas.CfnServerlessPrivateEndpoint build() {
            return new org.mongodb.awscdk.resources.mongodbatlas.CfnServerlessPrivateEndpoint(
                this.scope,
                this.id,
                this.props.build()
            );
        }
    }
}