io.github.cdklabs.cdkecsserviceextensions.AliasedPortMutatingHook Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cdk-ecs-service-extensions Show documentation
The CDK Construct Library that helps you build ECS services using simple extensions
There is a newer version: 2.0.1-alpha.507
Show newest version
package io.github.cdklabs.cdkecsserviceextensions;

/**
 * (experimental) This hook modifies the application container's settings so that its primary port mapping has a name.
 */
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-19T00:29:44.701Z")
@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.AliasedPortMutatingHook")
public class AliasedPortMutatingHook extends io.github.cdklabs.cdkecsserviceextensions.ContainerMutatingHook {

    protected AliasedPortMutatingHook(final software.amazon.jsii.JsiiObjectRef objRef) {
        super(objRef);
    }

    protected AliasedPortMutatingHook(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
        super(initializationMode);
    }

    /**
     * @param props This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    public AliasedPortMutatingHook(final @org.jetbrains.annotations.NotNull io.github.cdklabs.cdkecsserviceextensions.AliasedPortMutatingHookProps props) {
        super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
        software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(props, "props is required") });
    }

    /**
     * (experimental) This is a hook for modifying the container definition of any upstream containers.
     * 
     * This is primarily used for the main application container.
     * For example, the Firelens extension wants to be able to modify the logging
     * settings of the application container.
     * 

     * @param props This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    @Override
    public @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.ecs.ContainerDefinitionOptions mutateContainerDefinition(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.ecs.ContainerDefinitionOptions props) {
        return software.amazon.jsii.Kernel.call(this, "mutateContainerDefinition", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.ecs.ContainerDefinitionOptions.class), new Object[] { java.util.Objects.requireNonNull(props, "props is required") });
    }

    /**
     * (experimental) A fluent builder for {@link io.github.cdklabs.cdkecsserviceextensions.AliasedPortMutatingHook}.
     */
    @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}.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
        public static Builder create() {
            return new Builder();
        }

        private final io.github.cdklabs.cdkecsserviceextensions.AliasedPortMutatingHookProps.Builder props;

        private Builder() {
            this.props = new io.github.cdklabs.cdkecsserviceextensions.AliasedPortMutatingHookProps.Builder();
        }

        /**
         * (experimental) The port on the container which receives traffic.
         * 

         * This is the same as the containerPort property of port mapping.
         * 

         * @return {@code this}
         * @param aliasPort The port on the container which receives traffic. This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
        public Builder aliasPort(final java.lang.Number aliasPort) {
            this.props.aliasPort(aliasPort);
            return this;
        }

        /**
         * (experimental) The name by which to refer to this port mapping.
         * 

         * @return {@code this}
         * @param portMappingName The name by which to refer to this port mapping. This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
        public Builder portMappingName(final java.lang.String portMappingName) {
            this.props.portMappingName(portMappingName);
            return this;
        }

        /**
         * (experimental) The protocol which this port mapping expects to receive.
         * 

         * Default: - none
         * 
         * @return {@code this}
         * @param protocol The protocol which this port mapping expects to receive. This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
        public Builder protocol(final software.amazon.awscdk.services.ecs.AppProtocol protocol) {
            this.props.protocol(protocol);
            return this;
        }

        /**
         * @return a newly built instance of {@link io.github.cdklabs.cdkecsserviceextensions.AliasedPortMutatingHook}.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
        @Override
        public io.github.cdklabs.cdkecsserviceextensions.AliasedPortMutatingHook build() {
            return new io.github.cdklabs.cdkecsserviceextensions.AliasedPortMutatingHook(
                this.props.build()
            );
        }
    }
}