io.github.cdklabs.cdkecsserviceextensions.ImportedEnvironment Maven / Gradle / Ivy
Show all versions of cdk-ecs-service-extensions Show documentation
package io.github.cdklabs.cdkecsserviceextensions;
/**
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-21T00:38:42.479Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = io.github.cdklabs.cdkecsserviceextensions.$Module.class, fqn = "@aws-cdk-containers/ecs-service-extensions.ImportedEnvironment")
public class ImportedEnvironment extends software.constructs.Construct implements io.github.cdklabs.cdkecsserviceextensions.IEnvironment {
protected ImportedEnvironment(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected ImportedEnvironment(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* @param scope This parameter is required.
* @param id This parameter is required.
* @param props This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public ImportedEnvironment(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull io.github.cdklabs.cdkecsserviceextensions.EnvironmentAttributes 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") });
}
/**
* (experimental) Adding a default cloudmap namespace to the cluster will throw an error, as we don't own it.
*
* @param _options This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public void addDefaultCloudMapNamespace(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.ecs.CloudMapNamespaceOptions _options) {
software.amazon.jsii.Kernel.call(this, "addDefaultCloudMapNamespace", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(_options, "_options is required") });
}
/**
* (experimental) The capacity type used by the service's cluster.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull io.github.cdklabs.cdkecsserviceextensions.EnvironmentCapacityType getCapacityType() {
return software.amazon.jsii.Kernel.get(this, "capacityType", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.cdkecsserviceextensions.EnvironmentCapacityType.class));
}
/**
* (experimental) The cluster that is providing capacity for this service.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.ecs.ICluster getCluster() {
return software.amazon.jsii.Kernel.get(this, "cluster", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.ecs.ICluster.class));
}
/**
* (experimental) The name of this environment.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getId() {
return software.amazon.jsii.Kernel.get(this, "id", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) The VPC into which environment services should be placed.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.ec2.IVpc getVpc() {
return software.amazon.jsii.Kernel.get(this, "vpc", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.ec2.IVpc.class));
}
/**
* (experimental) A fluent builder for {@link io.github.cdklabs.cdkecsserviceextensions.ImportedEnvironment}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
/**
* @return a new instance of {@link Builder}.
* @param scope This parameter is required.
* @param id This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
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 io.github.cdklabs.cdkecsserviceextensions.EnvironmentAttributes.Builder props;
private Builder(final software.constructs.Construct scope, final java.lang.String id) {
this.scope = scope;
this.id = id;
this.props = new io.github.cdklabs.cdkecsserviceextensions.EnvironmentAttributes.Builder();
}
/**
* (experimental) The capacity type used by the service's cluster.
*
* @return {@code this}
* @param capacityType The capacity type used by the service's cluster. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder capacityType(final io.github.cdklabs.cdkecsserviceextensions.EnvironmentCapacityType capacityType) {
this.props.capacityType(capacityType);
return this;
}
/**
* (experimental) The cluster that is providing capacity for this service.
*
* @return {@code this}
* @param cluster The cluster that is providing capacity for this service. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder cluster(final software.amazon.awscdk.services.ecs.ICluster cluster) {
this.props.cluster(cluster);
return this;
}
/**
* @return a newly built instance of {@link io.github.cdklabs.cdkecsserviceextensions.ImportedEnvironment}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public io.github.cdklabs.cdkecsserviceextensions.ImportedEnvironment build() {
return new io.github.cdklabs.cdkecsserviceextensions.ImportedEnvironment(
this.scope,
this.id,
this.props.build()
);
}
}
}