All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.aws.gamelift.MatchmakingConfigurationArgs Maven / Gradle / Ivy

// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package com.pulumi.aws.gamelift;

import com.pulumi.aws.gamelift.inputs.MatchmakingConfigurationGamePropertyArgs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;


public final class MatchmakingConfigurationArgs extends com.pulumi.resources.ResourceArgs {

    public static final MatchmakingConfigurationArgs Empty = new MatchmakingConfigurationArgs();

    /**
     * Specifies if the match that was created with this configuration must be accepted by matched players.
     * 
     */
    @Import(name="acceptanceRequired")
    private @Nullable Output acceptanceRequired;

    /**
     * @return Specifies if the match that was created with this configuration must be accepted by matched players.
     * 
     */
    public Optional> acceptanceRequired() {
        return Optional.ofNullable(this.acceptanceRequired);
    }

    /**
     * The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
     * 
     */
    @Import(name="acceptanceTimeoutSeconds")
    private @Nullable Output acceptanceTimeoutSeconds;

    /**
     * @return The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
     * 
     */
    public Optional> acceptanceTimeoutSeconds() {
        return Optional.ofNullable(this.acceptanceTimeoutSeconds);
    }

    /**
     * The number of player slots in a match to keep open for future players.
     * 
     */
    @Import(name="additionalPlayerCount")
    private @Nullable Output additionalPlayerCount;

    /**
     * @return The number of player slots in a match to keep open for future players.
     * 
     */
    public Optional> additionalPlayerCount() {
        return Optional.ofNullable(this.additionalPlayerCount);
    }

    /**
     * The method used to backfill game sessions that are created with this matchmaking configuration.
     * 
     */
    @Import(name="backfillMode")
    private @Nullable Output backfillMode;

    /**
     * @return The method used to backfill game sessions that are created with this matchmaking configuration.
     * 
     */
    public Optional> backfillMode() {
        return Optional.ofNullable(this.backfillMode);
    }

    /**
     * Information to be added to all events related to this matchmaking configuration.
     * 
     */
    @Import(name="customEventData")
    private @Nullable Output customEventData;

    /**
     * @return Information to be added to all events related to this matchmaking configuration.
     * 
     */
    public Optional> customEventData() {
        return Optional.ofNullable(this.customEventData);
    }

    /**
     * A human-readable description of the matchmaking configuration.
     * 
     */
    @Import(name="description")
    private @Nullable Output description;

    /**
     * @return A human-readable description of the matchmaking configuration.
     * 
     */
    public Optional> description() {
        return Optional.ofNullable(this.description);
    }

    /**
     * Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.
     * 
     */
    @Import(name="flexMatchMode")
    private @Nullable Output flexMatchMode;

    /**
     * @return Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.
     * 
     */
    public Optional> flexMatchMode() {
        return Optional.ofNullable(this.flexMatchMode);
    }

    /**
     * One or more custom game properties. See below.
     * 
     */
    @Import(name="gameProperties")
    private @Nullable Output> gameProperties;

    /**
     * @return One or more custom game properties. See below.
     * 
     */
    public Optional>> gameProperties() {
        return Optional.ofNullable(this.gameProperties);
    }

    /**
     * A set of custom game session properties.
     * 
     */
    @Import(name="gameSessionData")
    private @Nullable Output gameSessionData;

    /**
     * @return A set of custom game session properties.
     * 
     */
    public Optional> gameSessionData() {
        return Optional.ofNullable(this.gameSessionData);
    }

    /**
     * The ARNs of the GameLift game session queue resources.
     * 
     */
    @Import(name="gameSessionQueueArns")
    private @Nullable Output> gameSessionQueueArns;

    /**
     * @return The ARNs of the GameLift game session queue resources.
     * 
     */
    public Optional>> gameSessionQueueArns() {
        return Optional.ofNullable(this.gameSessionQueueArns);
    }

    /**
     * Name of the matchmaking configuration
     * 
     */
    @Import(name="name")
    private @Nullable Output name;

    /**
     * @return Name of the matchmaking configuration
     * 
     */
    public Optional> name() {
        return Optional.ofNullable(this.name);
    }

    /**
     * An SNS topic ARN that is set up to receive matchmaking notifications.
     * 
     */
    @Import(name="notificationTarget")
    private @Nullable Output notificationTarget;

    /**
     * @return An SNS topic ARN that is set up to receive matchmaking notifications.
     * 
     */
    public Optional> notificationTarget() {
        return Optional.ofNullable(this.notificationTarget);
    }

    /**
     * The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
     * 
     */
    @Import(name="requestTimeoutSeconds", required=true)
    private Output requestTimeoutSeconds;

    /**
     * @return The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
     * 
     */
    public Output requestTimeoutSeconds() {
        return this.requestTimeoutSeconds;
    }

    /**
     * A rule set names for the matchmaking rule set to use with this configuration.
     * 
     */
    @Import(name="ruleSetName", required=true)
    private Output ruleSetName;

    /**
     * @return A rule set names for the matchmaking rule set to use with this configuration.
     * 
     */
    public Output ruleSetName() {
        return this.ruleSetName;
    }

    /**
     * Key-value map of resource tags. .If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
     * 
     */
    @Import(name="tags")
    private @Nullable Output> tags;

    /**
     * @return Key-value map of resource tags. .If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
     * 
     */
    public Optional>> tags() {
        return Optional.ofNullable(this.tags);
    }

    private MatchmakingConfigurationArgs() {}

    private MatchmakingConfigurationArgs(MatchmakingConfigurationArgs $) {
        this.acceptanceRequired = $.acceptanceRequired;
        this.acceptanceTimeoutSeconds = $.acceptanceTimeoutSeconds;
        this.additionalPlayerCount = $.additionalPlayerCount;
        this.backfillMode = $.backfillMode;
        this.customEventData = $.customEventData;
        this.description = $.description;
        this.flexMatchMode = $.flexMatchMode;
        this.gameProperties = $.gameProperties;
        this.gameSessionData = $.gameSessionData;
        this.gameSessionQueueArns = $.gameSessionQueueArns;
        this.name = $.name;
        this.notificationTarget = $.notificationTarget;
        this.requestTimeoutSeconds = $.requestTimeoutSeconds;
        this.ruleSetName = $.ruleSetName;
        this.tags = $.tags;
    }

    public static Builder builder() {
        return new Builder();
    }
    public static Builder builder(MatchmakingConfigurationArgs defaults) {
        return new Builder(defaults);
    }

    public static final class Builder {
        private MatchmakingConfigurationArgs $;

        public Builder() {
            $ = new MatchmakingConfigurationArgs();
        }

        public Builder(MatchmakingConfigurationArgs defaults) {
            $ = new MatchmakingConfigurationArgs(Objects.requireNonNull(defaults));
        }

        /**
         * @param acceptanceRequired Specifies if the match that was created with this configuration must be accepted by matched players.
         * 
         * @return builder
         * 
         */
        public Builder acceptanceRequired(@Nullable Output acceptanceRequired) {
            $.acceptanceRequired = acceptanceRequired;
            return this;
        }

        /**
         * @param acceptanceRequired Specifies if the match that was created with this configuration must be accepted by matched players.
         * 
         * @return builder
         * 
         */
        public Builder acceptanceRequired(Boolean acceptanceRequired) {
            return acceptanceRequired(Output.of(acceptanceRequired));
        }

        /**
         * @param acceptanceTimeoutSeconds The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
         * 
         * @return builder
         * 
         */
        public Builder acceptanceTimeoutSeconds(@Nullable Output acceptanceTimeoutSeconds) {
            $.acceptanceTimeoutSeconds = acceptanceTimeoutSeconds;
            return this;
        }

        /**
         * @param acceptanceTimeoutSeconds The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
         * 
         * @return builder
         * 
         */
        public Builder acceptanceTimeoutSeconds(Integer acceptanceTimeoutSeconds) {
            return acceptanceTimeoutSeconds(Output.of(acceptanceTimeoutSeconds));
        }

        /**
         * @param additionalPlayerCount The number of player slots in a match to keep open for future players.
         * 
         * @return builder
         * 
         */
        public Builder additionalPlayerCount(@Nullable Output additionalPlayerCount) {
            $.additionalPlayerCount = additionalPlayerCount;
            return this;
        }

        /**
         * @param additionalPlayerCount The number of player slots in a match to keep open for future players.
         * 
         * @return builder
         * 
         */
        public Builder additionalPlayerCount(Integer additionalPlayerCount) {
            return additionalPlayerCount(Output.of(additionalPlayerCount));
        }

        /**
         * @param backfillMode The method used to backfill game sessions that are created with this matchmaking configuration.
         * 
         * @return builder
         * 
         */
        public Builder backfillMode(@Nullable Output backfillMode) {
            $.backfillMode = backfillMode;
            return this;
        }

        /**
         * @param backfillMode The method used to backfill game sessions that are created with this matchmaking configuration.
         * 
         * @return builder
         * 
         */
        public Builder backfillMode(String backfillMode) {
            return backfillMode(Output.of(backfillMode));
        }

        /**
         * @param customEventData Information to be added to all events related to this matchmaking configuration.
         * 
         * @return builder
         * 
         */
        public Builder customEventData(@Nullable Output customEventData) {
            $.customEventData = customEventData;
            return this;
        }

        /**
         * @param customEventData Information to be added to all events related to this matchmaking configuration.
         * 
         * @return builder
         * 
         */
        public Builder customEventData(String customEventData) {
            return customEventData(Output.of(customEventData));
        }

        /**
         * @param description A human-readable description of the matchmaking configuration.
         * 
         * @return builder
         * 
         */
        public Builder description(@Nullable Output description) {
            $.description = description;
            return this;
        }

        /**
         * @param description A human-readable description of the matchmaking configuration.
         * 
         * @return builder
         * 
         */
        public Builder description(String description) {
            return description(Output.of(description));
        }

        /**
         * @param flexMatchMode Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.
         * 
         * @return builder
         * 
         */
        public Builder flexMatchMode(@Nullable Output flexMatchMode) {
            $.flexMatchMode = flexMatchMode;
            return this;
        }

        /**
         * @param flexMatchMode Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.
         * 
         * @return builder
         * 
         */
        public Builder flexMatchMode(String flexMatchMode) {
            return flexMatchMode(Output.of(flexMatchMode));
        }

        /**
         * @param gameProperties One or more custom game properties. See below.
         * 
         * @return builder
         * 
         */
        public Builder gameProperties(@Nullable Output> gameProperties) {
            $.gameProperties = gameProperties;
            return this;
        }

        /**
         * @param gameProperties One or more custom game properties. See below.
         * 
         * @return builder
         * 
         */
        public Builder gameProperties(List gameProperties) {
            return gameProperties(Output.of(gameProperties));
        }

        /**
         * @param gameProperties One or more custom game properties. See below.
         * 
         * @return builder
         * 
         */
        public Builder gameProperties(MatchmakingConfigurationGamePropertyArgs... gameProperties) {
            return gameProperties(List.of(gameProperties));
        }

        /**
         * @param gameSessionData A set of custom game session properties.
         * 
         * @return builder
         * 
         */
        public Builder gameSessionData(@Nullable Output gameSessionData) {
            $.gameSessionData = gameSessionData;
            return this;
        }

        /**
         * @param gameSessionData A set of custom game session properties.
         * 
         * @return builder
         * 
         */
        public Builder gameSessionData(String gameSessionData) {
            return gameSessionData(Output.of(gameSessionData));
        }

        /**
         * @param gameSessionQueueArns The ARNs of the GameLift game session queue resources.
         * 
         * @return builder
         * 
         */
        public Builder gameSessionQueueArns(@Nullable Output> gameSessionQueueArns) {
            $.gameSessionQueueArns = gameSessionQueueArns;
            return this;
        }

        /**
         * @param gameSessionQueueArns The ARNs of the GameLift game session queue resources.
         * 
         * @return builder
         * 
         */
        public Builder gameSessionQueueArns(List gameSessionQueueArns) {
            return gameSessionQueueArns(Output.of(gameSessionQueueArns));
        }

        /**
         * @param gameSessionQueueArns The ARNs of the GameLift game session queue resources.
         * 
         * @return builder
         * 
         */
        public Builder gameSessionQueueArns(String... gameSessionQueueArns) {
            return gameSessionQueueArns(List.of(gameSessionQueueArns));
        }

        /**
         * @param name Name of the matchmaking configuration
         * 
         * @return builder
         * 
         */
        public Builder name(@Nullable Output name) {
            $.name = name;
            return this;
        }

        /**
         * @param name Name of the matchmaking configuration
         * 
         * @return builder
         * 
         */
        public Builder name(String name) {
            return name(Output.of(name));
        }

        /**
         * @param notificationTarget An SNS topic ARN that is set up to receive matchmaking notifications.
         * 
         * @return builder
         * 
         */
        public Builder notificationTarget(@Nullable Output notificationTarget) {
            $.notificationTarget = notificationTarget;
            return this;
        }

        /**
         * @param notificationTarget An SNS topic ARN that is set up to receive matchmaking notifications.
         * 
         * @return builder
         * 
         */
        public Builder notificationTarget(String notificationTarget) {
            return notificationTarget(Output.of(notificationTarget));
        }

        /**
         * @param requestTimeoutSeconds The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
         * 
         * @return builder
         * 
         */
        public Builder requestTimeoutSeconds(Output requestTimeoutSeconds) {
            $.requestTimeoutSeconds = requestTimeoutSeconds;
            return this;
        }

        /**
         * @param requestTimeoutSeconds The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
         * 
         * @return builder
         * 
         */
        public Builder requestTimeoutSeconds(Integer requestTimeoutSeconds) {
            return requestTimeoutSeconds(Output.of(requestTimeoutSeconds));
        }

        /**
         * @param ruleSetName A rule set names for the matchmaking rule set to use with this configuration.
         * 
         * @return builder
         * 
         */
        public Builder ruleSetName(Output ruleSetName) {
            $.ruleSetName = ruleSetName;
            return this;
        }

        /**
         * @param ruleSetName A rule set names for the matchmaking rule set to use with this configuration.
         * 
         * @return builder
         * 
         */
        public Builder ruleSetName(String ruleSetName) {
            return ruleSetName(Output.of(ruleSetName));
        }

        /**
         * @param tags Key-value map of resource tags. .If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
         * 
         * @return builder
         * 
         */
        public Builder tags(@Nullable Output> tags) {
            $.tags = tags;
            return this;
        }

        /**
         * @param tags Key-value map of resource tags. .If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
         * 
         * @return builder
         * 
         */
        public Builder tags(Map tags) {
            return tags(Output.of(tags));
        }

        public MatchmakingConfigurationArgs build() {
            if ($.requestTimeoutSeconds == null) {
                throw new MissingRequiredPropertyException("MatchmakingConfigurationArgs", "requestTimeoutSeconds");
            }
            if ($.ruleSetName == null) {
                throw new MissingRequiredPropertyException("MatchmakingConfigurationArgs", "ruleSetName");
            }
            return $;
        }
    }

}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy