software.amazon.awscdk.services.dms.CfnReplicationSubnetGroup Maven / Gradle / Ivy
Show all versions of dms Show documentation
package software.amazon.awscdk.services.dms;
/**
* A CloudFormation AWS::DMS::ReplicationSubnetGroup.
*
* The AWS::DMS::ReplicationSubnetGroup resource creates an AWS DMS replication subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same AWS Region .
*
*
*
* Resource creation fails if the dms-vpc-role AWS Identity and Access Management ( IAM ) role doesn't already exist. For more information, see Creating the IAM Roles to Use With the AWS CLI and AWS DMS API in the AWS Database Migration Service User Guide .
*
*
*
* Example:
*
*
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import software.amazon.awscdk.services.dms.*;
* CfnReplicationSubnetGroup cfnReplicationSubnetGroup = CfnReplicationSubnetGroup.Builder.create(this, "MyCfnReplicationSubnetGroup")
* .replicationSubnetGroupDescription("replicationSubnetGroupDescription")
* .subnetIds(List.of("subnetIds"))
* // the properties below are optional
* .replicationSubnetGroupIdentifier("replicationSubnetGroupIdentifier")
* .tags(List.of(CfnTag.builder()
* .key("key")
* .value("value")
* .build()))
* .build();
*
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.84.0 (build 5404dcf)", date = "2023-06-19T16:29:56.407Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.dms.$Module.class, fqn = "@aws-cdk/aws-dms.CfnReplicationSubnetGroup")
public class CfnReplicationSubnetGroup extends software.amazon.awscdk.core.CfnResource implements software.amazon.awscdk.core.IInspectable {
protected CfnReplicationSubnetGroup(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected CfnReplicationSubnetGroup(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
static {
CFN_RESOURCE_TYPE_NAME = software.amazon.jsii.JsiiObject.jsiiStaticGet(software.amazon.awscdk.services.dms.CfnReplicationSubnetGroup.class, "CFN_RESOURCE_TYPE_NAME", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Create a new AWS::DMS::ReplicationSubnetGroup.
*
* @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 CfnReplicationSubnetGroup(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.core.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.dms.CfnReplicationSubnetGroupProps 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") });
}
/**
* Examines the CloudFormation resource and discloses attributes.
*
* @param inspector
- tree inspector to collect and process attributes.
This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public void inspect(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.core.TreeInspector inspector) {
software.amazon.jsii.Kernel.call(this, "inspect", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(inspector, "inspector is required") });
}
/**
* @param props This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
protected @org.jetbrains.annotations.NotNull java.util.Map renderProperties(final @org.jetbrains.annotations.NotNull java.util.Map props) {
return java.util.Collections.unmodifiableMap(software.amazon.jsii.Kernel.call(this, "renderProperties", software.amazon.jsii.NativeType.mapOf(software.amazon.jsii.NativeType.forClass(java.lang.Object.class)), new Object[] { 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;
/**
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
protected @org.jetbrains.annotations.NotNull java.util.Map getCfnProperties() {
return java.util.Collections.unmodifiableMap(software.amazon.jsii.Kernel.get(this, "cfnProperties", software.amazon.jsii.NativeType.mapOf(software.amazon.jsii.NativeType.forClass(java.lang.Object.class))));
}
/**
* One or more tags to be assigned to the subnet group.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull software.amazon.awscdk.core.TagManager getTags() {
return software.amazon.jsii.Kernel.get(this, "tags", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.core.TagManager.class));
}
/**
* The description for the subnet group.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.lang.String getReplicationSubnetGroupDescription() {
return software.amazon.jsii.Kernel.get(this, "replicationSubnetGroupDescription", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* The description for the subnet group.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setReplicationSubnetGroupDescription(final @org.jetbrains.annotations.NotNull java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "replicationSubnetGroupDescription", java.util.Objects.requireNonNull(value, "replicationSubnetGroupDescription is required"));
}
/**
* One or more subnet IDs to be assigned to the subnet group.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.NotNull java.util.List getSubnetIds() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "subnetIds", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class))));
}
/**
* One or more subnet IDs to be assigned to the subnet group.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setSubnetIds(final @org.jetbrains.annotations.NotNull java.util.List value) {
software.amazon.jsii.Kernel.set(this, "subnetIds", java.util.Objects.requireNonNull(value, "subnetIds is required"));
}
/**
* The identifier for the replication subnet group.
*
* If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the identifier.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public @org.jetbrains.annotations.Nullable java.lang.String getReplicationSubnetGroupIdentifier() {
return software.amazon.jsii.Kernel.get(this, "replicationSubnetGroupIdentifier", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* The identifier for the replication subnet group.
*
* If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the identifier.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public void setReplicationSubnetGroupIdentifier(final @org.jetbrains.annotations.Nullable java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "replicationSubnetGroupIdentifier", value);
}
/**
* A fluent builder for {@link software.amazon.awscdk.services.dms.CfnReplicationSubnetGroup}.
*/
@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.amazon.awscdk.core.Construct scope, final java.lang.String id) {
return new Builder(scope, id);
}
private final software.amazon.awscdk.core.Construct scope;
private final java.lang.String id;
private final software.amazon.awscdk.services.dms.CfnReplicationSubnetGroupProps.Builder props;
private Builder(final software.amazon.awscdk.core.Construct scope, final java.lang.String id) {
this.scope = scope;
this.id = id;
this.props = new software.amazon.awscdk.services.dms.CfnReplicationSubnetGroupProps.Builder();
}
/**
* The description for the subnet group.
*
* @return {@code this}
* @param replicationSubnetGroupDescription The description for the subnet group. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder replicationSubnetGroupDescription(final java.lang.String replicationSubnetGroupDescription) {
this.props.replicationSubnetGroupDescription(replicationSubnetGroupDescription);
return this;
}
/**
* One or more subnet IDs to be assigned to the subnet group.
*
* @return {@code this}
* @param subnetIds One or more subnet IDs to be assigned to the subnet group. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder subnetIds(final java.util.List subnetIds) {
this.props.subnetIds(subnetIds);
return this;
}
/**
* The identifier for the replication subnet group.
*
* If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the identifier.
*
* @return {@code this}
* @param replicationSubnetGroupIdentifier The identifier for the replication subnet group. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder replicationSubnetGroupIdentifier(final java.lang.String replicationSubnetGroupIdentifier) {
this.props.replicationSubnetGroupIdentifier(replicationSubnetGroupIdentifier);
return this;
}
/**
* One or more tags to be assigned to the subnet group.
*
* @return {@code this}
* @param tags One or more tags to be assigned to the subnet group. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder tags(final java.util.List tags) {
this.props.tags(tags);
return this;
}
/**
* @return a newly built instance of {@link software.amazon.awscdk.services.dms.CfnReplicationSubnetGroup}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public software.amazon.awscdk.services.dms.CfnReplicationSubnetGroup build() {
return new software.amazon.awscdk.services.dms.CfnReplicationSubnetGroup(
this.scope,
this.id,
this.props.build()
);
}
}
}