io.github.cdklabs.cdkecsserviceextensions.IEnvironment Maven / Gradle / Ivy
Show all versions of cdk-ecs-service-extensions Show documentation
package io.github.cdklabs.cdkecsserviceextensions;
/**
* (experimental) An environment into which to deploy a service.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-26T00:28:54.209Z")
@software.amazon.jsii.Jsii(module = io.github.cdklabs.cdkecsserviceextensions.$Module.class, fqn = "@aws-cdk-containers/ecs-service-extensions.IEnvironment")
@software.amazon.jsii.Jsii.Proxy(IEnvironment.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public interface IEnvironment extends software.amazon.jsii.JsiiSerializable {
/**
* (experimental) The capacity type used by the service's cluster.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull io.github.cdklabs.cdkecsserviceextensions.EnvironmentCapacityType getCapacityType();
/**
* (experimental) The cluster that is providing capacity for this service.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull software.amazon.awscdk.services.ecs.ICluster getCluster();
/**
* (experimental) The name of this environment.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull java.lang.String getId();
/**
* (experimental) The VPC into which environment services should be placed.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull software.amazon.awscdk.services.ec2.IVpc getVpc();
/**
* (experimental) Add a default cloudmap namespace to the environment's cluster.
*
* @param options This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
void addDefaultCloudMapNamespace(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.ecs.CloudMapNamespaceOptions options);
/**
* A proxy class which represents a concrete javascript instance of this type.
*/
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements io.github.cdklabs.cdkecsserviceextensions.IEnvironment.Jsii$Default {
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
/**
* (experimental) The capacity type used by the service's cluster.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final @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 final @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 final @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 final @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) Add a default cloudmap namespace to the environment's cluster.
*
* @param options This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public final 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") });
}
}
/**
* Internal default implementation for {@link IEnvironment}.
*/
@software.amazon.jsii.Internal
interface Jsii$Default extends IEnvironment {
/**
* (experimental) The capacity type used by the service's cluster.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @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)
default @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)
default @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)
default @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) Add a default cloudmap namespace to the environment's cluster.
*
* @param options This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
default 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") });
}
}
}