org.graylog.aws.AWS Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of graylog2-server Show documentation

Graylog

There is a newer version: 6.1.4

/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * .
 */
package org.graylog.aws;

import com.amazonaws.regions.Regions;
import com.google.common.collect.Maps;

import java.util.Map;

import static org.graylog2.shared.utilities.StringUtils.f;

/**
 * A common utils class for the AWS plugin.
 */
public class AWS {

    public static final String SOURCE_GROUP_IDENTIFIER = "aws_source";
    public static final String FIELD_LOG_GROUP = "aws_log_group";
    public static final String FIELD_LOG_STREAM = "aws_log_stream";

    // This is a non-instantiable utils class.
    private AWS() {
    }

    /**
     * Build a list of region choices with both a value (persisted in configuration) and display value (shown to the user).
     *
     * The display value is formatted nicely: "EU (London): eu-west-2"
     * The value is eventually passed to Regions.fromName() to get the actual region object: eu-west-2
     * @return a choices map with configuration value map keys and display value map values.
     */
    public static Map buildRegionChoices() {
        Map regions = Maps.newHashMap();
        for (Regions region : Regions.values()) {

            String displayValue = f("%s: %s", region.getDescription(), region.getName());
            regions.put(region.getName(), displayValue);
        }
        return regions;
    }
}