org.mongodb.awscdk.resources.mongodbatlas.CfnCloudBackUpRestoreJobs Maven / Gradle / Ivy
Show all versions of awscdk-resources-mongodbatlas Show documentation
package org.mongodb.awscdk.resources.mongodbatlas;
/**
* A CloudFormation MongoDB::Atlas::CloudBackUpRestoreJobs.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.94.0 (build b380f01)", date = "2024-02-05T16:04:31.791Z")
@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.CfnCloudBackUpRestoreJobs")
public class CfnCloudBackUpRestoreJobs extends software.amazon.awscdk.CfnResource {
protected CfnCloudBackUpRestoreJobs(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected CfnCloudBackUpRestoreJobs(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
static {
CFN_RESOURCE_TYPE_NAME = software.amazon.jsii.JsiiObject.jsiiStaticGet(org.mongodb.awscdk.resources.mongodbatlas.CfnCloudBackUpRestoreJobs.class, "CFN_RESOURCE_TYPE_NAME", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Create a new MongoDB::Atlas::CloudBackUpRestoreJobs.
*
* @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 CfnCloudBackUpRestoreJobs(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.CfnCloudBackUpRestoreJobsProps 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::CloudBackUpRestoreJobs.DeliveryUrl.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.util.List getAttrDeliveryUrl() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "attrDeliveryUrl", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class))));
}
/**
* Attribute MongoDB::Atlas::CloudBackUpRestoreJobs.ExpiresAt.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getAttrExpiresAt() {
return software.amazon.jsii.Kernel.get(this, "attrExpiresAt", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Attribute MongoDB::Atlas::CloudBackUpRestoreJobs.FinishedAt.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getAttrFinishedAt() {
return software.amazon.jsii.Kernel.get(this, "attrFinishedAt", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Attribute MongoDB::Atlas::CloudBackUpRestoreJobs.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::CloudBackUpRestoreJobs.Timestamp.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getAttrTimestamp() {
return software.amazon.jsii.Kernel.get(this, "attrTimestamp", 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.CfnCloudBackUpRestoreJobsProps getProps() {
return software.amazon.jsii.Kernel.get(this, "props", software.amazon.jsii.NativeType.forClass(org.mongodb.awscdk.resources.mongodbatlas.CfnCloudBackUpRestoreJobsProps.class));
}
/**
* A fluent builder for {@link org.mongodb.awscdk.resources.mongodbatlas.CfnCloudBackUpRestoreJobs}.
*/
@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.CfnCloudBackUpRestoreJobsProps.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.CfnCloudBackUpRestoreJobsProps.Builder();
}
/**
* Type of restore job to create.The value can be any one of download,automated or point_in_time.
*
* @return {@code this}
* @param deliveryType Type of restore job to create.The value can be any one of download,automated or point_in_time. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder deliveryType(final org.mongodb.awscdk.resources.mongodbatlas.CfnCloudBackUpRestoreJobsPropsDeliveryType deliveryType) {
this.props.deliveryType(deliveryType);
return this;
}
/**
* The instance name of the Serverless/Cluster whose snapshot you want to restore or you want to retrieve restore jobs.
*
* @return {@code this}
* @param instanceName The instance name of the Serverless/Cluster whose snapshot you want to restore or you want to retrieve restore jobs. 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;
}
/**
* Type of instance specified on the Instance Name serverless or cluster.
*
* @return {@code this}
* @param instanceType Type of instance specified on the Instance Name serverless or cluster. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder instanceType(final org.mongodb.awscdk.resources.mongodbatlas.CfnCloudBackUpRestoreJobsPropsInstanceType instanceType) {
this.props.instanceType(instanceType);
return this;
}
/**
* The unique identifier of the project for the Atlas cluster.
*
* @return {@code this}
* @param projectId The unique identifier of the project for the Atlas cluster. 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;
}
/**
* Unique identifier of the source snapshot ID of the restore job.
*
* @return {@code this}
* @param snapshotId Unique identifier of the source snapshot ID of the restore job. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder snapshotId(final java.lang.String snapshotId) {
this.props.snapshotId(snapshotId);
return this;
}
/**
* Indicates whether the restore job was canceled.
*
* @return {@code this}
* @param cancelled Indicates whether the restore job was canceled. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder cancelled(final java.lang.Boolean cancelled) {
this.props.cancelled(cancelled);
return this;
}
/**
* If set to true, the CloudFormation resource will wait until the job is completed, WARNING: if the snapshot has a big load of data, the cloud formation resource might take a long time to finish leading to high costs.
*
* @return {@code this}
* @param enableSynchronousCreation If set to true, the CloudFormation resource will wait until the job is completed, WARNING: if the snapshot has a big load of data, the cloud formation resource might take a long time to finish leading to high costs. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder enableSynchronousCreation(final java.lang.Boolean enableSynchronousCreation) {
this.props.enableSynchronousCreation(enableSynchronousCreation);
return this;
}
/**
* Indicates whether the restore job expired.
*
* @return {@code this}
* @param expired Indicates whether the restore job expired. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder expired(final java.lang.Boolean expired) {
this.props.expired(expired);
return this;
}
/**
* Indicates whether the restore job failed.
*
* @return {@code this}
* @param failed Indicates whether the restore job failed. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder failed(final java.lang.Boolean failed) {
this.props.failed(failed);
return this;
}
/**
* Oplog operation number from which to you want to restore this snapshot.
*
* This is the second part of an Oplog timestamp.
*
* @return {@code this}
* @param opLogInc Oplog operation number from which to you want to restore this snapshot. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder opLogInc(final java.lang.String opLogInc) {
this.props.opLogInc(opLogInc);
return this;
}
/**
* Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot.
*
* This is the first part of an Oplog timestamp.
*
* @return {@code this}
* @param opLogTs Timestamp in the number of seconds that have elapsed since the UNIX epoch from which to you want to restore this snapshot. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder opLogTs(final java.lang.String opLogTs) {
this.props.opLogTs(opLogTs);
return this;
}
/**
* If you performed a Point-in-Time restores at a time specified by a Unix time in seconds since epoch, pointInTimeUTCSeconds indicates the Unix time used.
*
* @return {@code this}
* @param pointInTimeUtcSeconds If you performed a Point-in-Time restores at a time specified by a Unix time in seconds since epoch, pointInTimeUTCSeconds indicates the Unix time used. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder pointInTimeUtcSeconds(final java.lang.Number pointInTimeUtcSeconds) {
this.props.pointInTimeUtcSeconds(pointInTimeUtcSeconds);
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;
}
/**
* Options that needs to be set to control the synchronous creation flow, this options need to be set if EnableSynchronousCreation is se to TRUE.
*
* @return {@code this}
* @param synchronousCreationOptions Options that needs to be set to control the synchronous creation flow, this options need to be set if EnableSynchronousCreation is se to TRUE. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder synchronousCreationOptions(final org.mongodb.awscdk.resources.mongodbatlas.SynchronousCreationOptions synchronousCreationOptions) {
this.props.synchronousCreationOptions(synchronousCreationOptions);
return this;
}
/**
* Name of the target Atlas cluster to which the restore job restores the snapshot.
*
* Only visible if deliveryType is automated.
*
* @return {@code this}
* @param targetClusterName Name of the target Atlas cluster to which the restore job restores the snapshot. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder targetClusterName(final java.lang.String targetClusterName) {
this.props.targetClusterName(targetClusterName);
return this;
}
/**
* Name of the target Atlas project of the restore job.
*
* Only visible if deliveryType is automated.
*
* @return {@code this}
* @param targetProjectId Name of the target Atlas project of the restore job. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder targetProjectId(final java.lang.String targetProjectId) {
this.props.targetProjectId(targetProjectId);
return this;
}
/**
* @return a newly built instance of {@link org.mongodb.awscdk.resources.mongodbatlas.CfnCloudBackUpRestoreJobs}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public org.mongodb.awscdk.resources.mongodbatlas.CfnCloudBackUpRestoreJobs build() {
return new org.mongodb.awscdk.resources.mongodbatlas.CfnCloudBackUpRestoreJobs(
this.scope,
this.id,
this.props.build()
);
}
}
}