org.mongodb.awscdk.resources.mongodbatlas.CfnCloudBackupSnapshot Maven / Gradle / Ivy
Show all versions of awscdk-resources-mongodbatlas Show documentation
package org.mongodb.awscdk.resources.mongodbatlas;
/**
* A CloudFormation MongoDB::Atlas::CloudBackupSnapshot.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.101.0 (build b95fe5d)", date = "2024-07-30T09:54:28.902Z")
@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.CfnCloudBackupSnapshot")
public class CfnCloudBackupSnapshot extends software.amazon.awscdk.CfnResource {
protected CfnCloudBackupSnapshot(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected CfnCloudBackupSnapshot(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
static {
CFN_RESOURCE_TYPE_NAME = software.amazon.jsii.JsiiObject.jsiiStaticGet(org.mongodb.awscdk.resources.mongodbatlas.CfnCloudBackupSnapshot.class, "CFN_RESOURCE_TYPE_NAME", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Create a new MongoDB::Atlas::CloudBackupSnapshot.
*
* @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 CfnCloudBackupSnapshot(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.CfnCloudBackupSnapshotProps 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::CloudBackupSnapshot.CloudProvider.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getAttrCloudProvider() {
return software.amazon.jsii.Kernel.get(this, "attrCloudProvider", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Attribute MongoDB::Atlas::CloudBackupSnapshot.CreatedAt.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getAttrCreatedAt() {
return software.amazon.jsii.Kernel.get(this, "attrCreatedAt", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Attribute MongoDB::Atlas::CloudBackupSnapshot.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::CloudBackupSnapshot.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::CloudBackupSnapshot.MasterKeyUUID.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getAttrMasterKeyUUID() {
return software.amazon.jsii.Kernel.get(this, "attrMasterKeyUUID", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Attribute MongoDB::Atlas::CloudBackupSnapshot.MongodVersion.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getAttrMongodVersion() {
return software.amazon.jsii.Kernel.get(this, "attrMongodVersion", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Attribute MongoDB::Atlas::CloudBackupSnapshot.ReplicaSetName.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getAttrReplicaSetName() {
return software.amazon.jsii.Kernel.get(this, "attrReplicaSetName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Attribute MongoDB::Atlas::CloudBackupSnapshot.SnapshotId.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getAttrSnapshotId() {
return software.amazon.jsii.Kernel.get(this, "attrSnapshotId", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Attribute MongoDB::Atlas::CloudBackupSnapshot.SnapshotIds.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.util.List getAttrSnapshotIds() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "attrSnapshotIds", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class))));
}
/**
* Attribute MongoDB::Atlas::CloudBackupSnapshot.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));
}
/**
* Attribute MongoDB::Atlas::CloudBackupSnapshot.StorageSizeBytes.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getAttrStorageSizeBytes() {
return software.amazon.jsii.Kernel.get(this, "attrStorageSizeBytes", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Attribute MongoDB::Atlas::CloudBackupSnapshot.Type.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getAttrType() {
return software.amazon.jsii.Kernel.get(this, "attrType", 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.CfnCloudBackupSnapshotProps getProps() {
return software.amazon.jsii.Kernel.get(this, "props", software.amazon.jsii.NativeType.forClass(org.mongodb.awscdk.resources.mongodbatlas.CfnCloudBackupSnapshotProps.class));
}
/**
* A fluent builder for {@link org.mongodb.awscdk.resources.mongodbatlas.CfnCloudBackupSnapshot}.
*/
@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.CfnCloudBackupSnapshotProps.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.CfnCloudBackupSnapshotProps.Builder();
}
/**
* The instance name of the Serverless/Cluster whose snapshot you want to restore or you want to retrieve restore snapshot.
*
* @return {@code this}
* @param instanceName The instance name of the Serverless/Cluster whose snapshot you want to restore or you want to retrieve restore snapshot. 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.CfnCloudBackupSnapshotPropsInstanceType instanceType) {
this.props.instanceType(instanceType);
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;
}
/**
* Human-readable phrase or sentence that explains the purpose of the snapshot.
*
* The resource returns this parameter when "status": "onDemand".
*
* @return {@code this}
* @param description Human-readable phrase or sentence that explains the purpose of the snapshot. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder description(final java.lang.String description) {
this.props.description(description);
return this;
}
/**
* Human-readable label that identifies how often this snapshot triggers.
*
* @return {@code this}
* @param frequencyType Human-readable label that identifies how often this snapshot triggers. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder frequencyType(final org.mongodb.awscdk.resources.mongodbatlas.CfnCloudBackupSnapshotPropsFrequencyType frequencyType) {
this.props.frequencyType(frequencyType);
return this;
}
/**
* Flag that indicates whether the response returns the total number of items (totalCount) in the response.
*
* @return {@code this}
* @param includeCount Flag that indicates whether the response returns the total number of items (totalCount) in the response. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder includeCount(final java.lang.Boolean includeCount) {
this.props.includeCount(includeCount);
return this;
}
/**
* Number of items that the response returns per page.
*
* @return {@code this}
* @param itemsPerPage Number of items that the response returns per page. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder itemsPerPage(final java.lang.Number itemsPerPage) {
this.props.itemsPerPage(itemsPerPage);
return this;
}
/**
* List that includes the snapshots and the cloud provider that stores the snapshots.
*
* The resource returns this parameter when "type" : "SHARDED_CLUSTER".
*
* @return {@code this}
* @param members List that includes the snapshots and the cloud provider that stores the snapshots. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder members(final java.util.List members) {
this.props.members(members);
return this;
}
/**
* Number of the page that displays the current set of the total objects that the response returns.
*
* @return {@code this}
* @param pageNum Number of the page that displays the current set of the total objects that the response returns. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder pageNum(final java.lang.Number pageNum) {
this.props.pageNum(pageNum);
return this;
}
/**
* List that contains unique identifiers for the policy items.
*
* @return {@code this}
* @param policyItems List that contains unique identifiers for the policy items. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder policyItems(final java.util.List policyItems) {
this.props.policyItems(policyItems);
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;
}
/**
* List of returned documents that MongoDB Cloud provides when completing this request.
*
* @return {@code this}
* @param results List of returned documents that MongoDB Cloud provides when completing this request. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder results(final java.util.List results) {
this.props.results(results);
return this;
}
/**
* Number of days that MongoDB Cloud should retain the on-demand snapshot.
*
* Must be at least 1
*
* @return {@code this}
* @param retentionInDays Number of days that MongoDB Cloud should retain the on-demand snapshot. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder retentionInDays(final java.lang.Number retentionInDays) {
this.props.retentionInDays(retentionInDays);
return this;
}
/**
* Human-readable label that identifies when this snapshot triggers.
*
* @return {@code this}
* @param snapshotType Human-readable label that identifies when this snapshot triggers. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder snapshotType(final org.mongodb.awscdk.resources.mongodbatlas.CfnCloudBackupSnapshotPropsSnapshotType snapshotType) {
this.props.snapshotType(snapshotType);
return this;
}
/**
* Number of documents returned in this response.
*
* @return {@code this}
* @param totalCount Number of documents returned in this response. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder totalCount(final java.lang.Number totalCount) {
this.props.totalCount(totalCount);
return this;
}
/**
* @return a newly built instance of {@link org.mongodb.awscdk.resources.mongodbatlas.CfnCloudBackupSnapshot}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public org.mongodb.awscdk.resources.mongodbatlas.CfnCloudBackupSnapshot build() {
return new org.mongodb.awscdk.resources.mongodbatlas.CfnCloudBackupSnapshot(
this.scope,
this.id,
this.props.build()
);
}
}
}