RadiusSettings

Manages a directory’s multi-factor authentication (MFA) using a Remote Authentication Dial In User Service (RADIUS) server.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.DirectoryService.RadiusSettings("example", new()
    {
        DirectoryId = aws_directory_service_directory.Example.Id,
        AuthenticationProtocol = "PAP",
        DisplayLabel = "example",
        RadiusPort = 1812,
        RadiusRetries = 4,
        RadiusServers = new[]
        {
            "10.0.1.5",
        },
        RadiusTimeout = 1,
        SharedSecret = "12345678",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/directoryservice"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := directoryservice.NewRadiusSettings(ctx, "example", &directoryservice.RadiusSettingsArgs{
			DirectoryId:            pulumi.Any(aws_directory_service_directory.Example.Id),
			AuthenticationProtocol: pulumi.String("PAP"),
			DisplayLabel:           pulumi.String("example"),
			RadiusPort:             pulumi.Int(1812),
			RadiusRetries:          pulumi.Int(4),
			RadiusServers: pulumi.StringArray{
				pulumi.String("10.0.1.5"),
			},
			RadiusTimeout: pulumi.Int(1),
			SharedSecret:  pulumi.String("12345678"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.directoryservice.RadiusSettings;
import com.pulumi.aws.directoryservice.RadiusSettingsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new RadiusSettings("example", RadiusSettingsArgs.builder()        
            .directoryId(aws_directory_service_directory.example().id())
            .authenticationProtocol("PAP")
            .displayLabel("example")
            .radiusPort(1812)
            .radiusRetries(4)
            .radiusServers("10.0.1.5")
            .radiusTimeout(1)
            .sharedSecret("12345678")
            .build());

    }
}
import pulumi
import pulumi_aws as aws

example = aws.directoryservice.RadiusSettings("example",
    directory_id=aws_directory_service_directory["example"]["id"],
    authentication_protocol="PAP",
    display_label="example",
    radius_port=1812,
    radius_retries=4,
    radius_servers=["10.0.1.5"],
    radius_timeout=1,
    shared_secret="12345678")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.directoryservice.RadiusSettings("example", {
    directoryId: aws_directory_service_directory.example.id,
    authenticationProtocol: "PAP",
    displayLabel: "example",
    radiusPort: 1812,
    radiusRetries: 4,
    radiusServers: ["10.0.1.5"],
    radiusTimeout: 1,
    sharedSecret: "12345678",
});
resources:
  example:
    type: aws:directoryservice:RadiusSettings
    properties:
      directoryId: ${aws_directory_service_directory.example.id}
      authenticationProtocol: PAP
      displayLabel: example
      radiusPort: 1812
      radiusRetries: 4
      radiusServers:
        - 10.0.1.5
      radiusTimeout: 1
      sharedSecret: '12345678'

Create RadiusSettings Resource

new RadiusSettings(name: string, args: RadiusSettingsArgs, opts?: CustomResourceOptions);
@overload
def RadiusSettings(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   authentication_protocol: Optional[str] = None,
                   directory_id: Optional[str] = None,
                   display_label: Optional[str] = None,
                   radius_port: Optional[int] = None,
                   radius_retries: Optional[int] = None,
                   radius_servers: Optional[Sequence[str]] = None,
                   radius_timeout: Optional[int] = None,
                   shared_secret: Optional[str] = None,
                   use_same_username: Optional[bool] = None)
@overload
def RadiusSettings(resource_name: str,
                   args: RadiusSettingsArgs,
                   opts: Optional[ResourceOptions] = None)
func NewRadiusSettings(ctx *Context, name string, args RadiusSettingsArgs, opts ...ResourceOption) (*RadiusSettings, error)
public RadiusSettings(string name, RadiusSettingsArgs args, CustomResourceOptions? opts = null)
public RadiusSettings(String name, RadiusSettingsArgs args)
public RadiusSettings(String name, RadiusSettingsArgs args, CustomResourceOptions options)
type: aws:directoryservice:RadiusSettings
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args RadiusSettingsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args RadiusSettingsArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args RadiusSettingsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args RadiusSettingsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args RadiusSettingsArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

RadiusSettings Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The RadiusSettings resource accepts the following input properties:

AuthenticationProtocol string

The protocol specified for your RADIUS endpoints. Valid values: PAP, CHAP, MS-CHAPv1, MS-CHAPv2.

DirectoryId string

The identifier of the directory for which you want to manager RADIUS settings.

DisplayLabel string

Display label.

RadiusPort int

The port that your RADIUS server is using for communications. Your self-managed network must allow inbound traffic over this port from the AWS Directory Service servers.

RadiusRetries int

The maximum number of times that communication with the RADIUS server is attempted. Minimum value of 0. Maximum value of 10.

RadiusServers List<string>

An array of strings that contains the fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.

RadiusTimeout int

The amount of time, in seconds, to wait for the RADIUS server to respond. Minimum value of 1. Maximum value of 50.

SharedSecret string

Required for enabling RADIUS on the directory.

UseSameUsername bool

Not currently used.

AuthenticationProtocol string

The protocol specified for your RADIUS endpoints. Valid values: PAP, CHAP, MS-CHAPv1, MS-CHAPv2.

DirectoryId string

The identifier of the directory for which you want to manager RADIUS settings.

DisplayLabel string

Display label.

RadiusPort int

The port that your RADIUS server is using for communications. Your self-managed network must allow inbound traffic over this port from the AWS Directory Service servers.

RadiusRetries int

The maximum number of times that communication with the RADIUS server is attempted. Minimum value of 0. Maximum value of 10.

RadiusServers []string

An array of strings that contains the fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.

RadiusTimeout int

The amount of time, in seconds, to wait for the RADIUS server to respond. Minimum value of 1. Maximum value of 50.

SharedSecret string

Required for enabling RADIUS on the directory.

UseSameUsername bool

Not currently used.

authenticationProtocol String

The protocol specified for your RADIUS endpoints. Valid values: PAP, CHAP, MS-CHAPv1, MS-CHAPv2.

directoryId String

The identifier of the directory for which you want to manager RADIUS settings.

displayLabel String

Display label.

radiusPort Integer

The port that your RADIUS server is using for communications. Your self-managed network must allow inbound traffic over this port from the AWS Directory Service servers.

radiusRetries Integer

The maximum number of times that communication with the RADIUS server is attempted. Minimum value of 0. Maximum value of 10.

radiusServers List<String>

An array of strings that contains the fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.

radiusTimeout Integer

The amount of time, in seconds, to wait for the RADIUS server to respond. Minimum value of 1. Maximum value of 50.

sharedSecret String

Required for enabling RADIUS on the directory.

useSameUsername Boolean

Not currently used.

authenticationProtocol string

The protocol specified for your RADIUS endpoints. Valid values: PAP, CHAP, MS-CHAPv1, MS-CHAPv2.

directoryId string

The identifier of the directory for which you want to manager RADIUS settings.

displayLabel string

Display label.

radiusPort number

The port that your RADIUS server is using for communications. Your self-managed network must allow inbound traffic over this port from the AWS Directory Service servers.

radiusRetries number

The maximum number of times that communication with the RADIUS server is attempted. Minimum value of 0. Maximum value of 10.

radiusServers string[]

An array of strings that contains the fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.

radiusTimeout number

The amount of time, in seconds, to wait for the RADIUS server to respond. Minimum value of 1. Maximum value of 50.

sharedSecret string

Required for enabling RADIUS on the directory.

useSameUsername boolean

Not currently used.

authentication_protocol str

The protocol specified for your RADIUS endpoints. Valid values: PAP, CHAP, MS-CHAPv1, MS-CHAPv2.

directory_id str

The identifier of the directory for which you want to manager RADIUS settings.

display_label str

Display label.

radius_port int

The port that your RADIUS server is using for communications. Your self-managed network must allow inbound traffic over this port from the AWS Directory Service servers.

radius_retries int

The maximum number of times that communication with the RADIUS server is attempted. Minimum value of 0. Maximum value of 10.

radius_servers Sequence[str]

An array of strings that contains the fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.

radius_timeout int

The amount of time, in seconds, to wait for the RADIUS server to respond. Minimum value of 1. Maximum value of 50.

shared_secret str

Required for enabling RADIUS on the directory.

use_same_username bool

Not currently used.

authenticationProtocol String

The protocol specified for your RADIUS endpoints. Valid values: PAP, CHAP, MS-CHAPv1, MS-CHAPv2.

directoryId String

The identifier of the directory for which you want to manager RADIUS settings.

displayLabel String

Display label.

radiusPort Number

The port that your RADIUS server is using for communications. Your self-managed network must allow inbound traffic over this port from the AWS Directory Service servers.

radiusRetries Number

The maximum number of times that communication with the RADIUS server is attempted. Minimum value of 0. Maximum value of 10.

radiusServers List<String>

An array of strings that contains the fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.

radiusTimeout Number

The amount of time, in seconds, to wait for the RADIUS server to respond. Minimum value of 1. Maximum value of 50.

sharedSecret String

Required for enabling RADIUS on the directory.

useSameUsername Boolean

Not currently used.

Outputs

All input properties are implicitly available as output properties. Additionally, the RadiusSettings resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing RadiusSettings Resource

Get an existing RadiusSettings resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: RadiusSettingsState, opts?: CustomResourceOptions): RadiusSettings
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authentication_protocol: Optional[str] = None,
        directory_id: Optional[str] = None,
        display_label: Optional[str] = None,
        radius_port: Optional[int] = None,
        radius_retries: Optional[int] = None,
        radius_servers: Optional[Sequence[str]] = None,
        radius_timeout: Optional[int] = None,
        shared_secret: Optional[str] = None,
        use_same_username: Optional[bool] = None) -> RadiusSettings
func GetRadiusSettings(ctx *Context, name string, id IDInput, state *RadiusSettingsState, opts ...ResourceOption) (*RadiusSettings, error)
public static RadiusSettings Get(string name, Input<string> id, RadiusSettingsState? state, CustomResourceOptions? opts = null)
public static RadiusSettings get(String name, Output<String> id, RadiusSettingsState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AuthenticationProtocol string

The protocol specified for your RADIUS endpoints. Valid values: PAP, CHAP, MS-CHAPv1, MS-CHAPv2.

DirectoryId string

The identifier of the directory for which you want to manager RADIUS settings.

DisplayLabel string

Display label.

RadiusPort int

The port that your RADIUS server is using for communications. Your self-managed network must allow inbound traffic over this port from the AWS Directory Service servers.

RadiusRetries int

The maximum number of times that communication with the RADIUS server is attempted. Minimum value of 0. Maximum value of 10.

RadiusServers List<string>

An array of strings that contains the fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.

RadiusTimeout int

The amount of time, in seconds, to wait for the RADIUS server to respond. Minimum value of 1. Maximum value of 50.

SharedSecret string

Required for enabling RADIUS on the directory.

UseSameUsername bool

Not currently used.

AuthenticationProtocol string

The protocol specified for your RADIUS endpoints. Valid values: PAP, CHAP, MS-CHAPv1, MS-CHAPv2.

DirectoryId string

The identifier of the directory for which you want to manager RADIUS settings.

DisplayLabel string

Display label.

RadiusPort int

The port that your RADIUS server is using for communications. Your self-managed network must allow inbound traffic over this port from the AWS Directory Service servers.

RadiusRetries int

The maximum number of times that communication with the RADIUS server is attempted. Minimum value of 0. Maximum value of 10.

RadiusServers []string

An array of strings that contains the fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.

RadiusTimeout int

The amount of time, in seconds, to wait for the RADIUS server to respond. Minimum value of 1. Maximum value of 50.

SharedSecret string

Required for enabling RADIUS on the directory.

UseSameUsername bool

Not currently used.

authenticationProtocol String

The protocol specified for your RADIUS endpoints. Valid values: PAP, CHAP, MS-CHAPv1, MS-CHAPv2.

directoryId String

The identifier of the directory for which you want to manager RADIUS settings.

displayLabel String

Display label.

radiusPort Integer

The port that your RADIUS server is using for communications. Your self-managed network must allow inbound traffic over this port from the AWS Directory Service servers.

radiusRetries Integer

The maximum number of times that communication with the RADIUS server is attempted. Minimum value of 0. Maximum value of 10.

radiusServers List<String>

An array of strings that contains the fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.

radiusTimeout Integer

The amount of time, in seconds, to wait for the RADIUS server to respond. Minimum value of 1. Maximum value of 50.

sharedSecret String

Required for enabling RADIUS on the directory.

useSameUsername Boolean

Not currently used.

authenticationProtocol string

The protocol specified for your RADIUS endpoints. Valid values: PAP, CHAP, MS-CHAPv1, MS-CHAPv2.

directoryId string

The identifier of the directory for which you want to manager RADIUS settings.

displayLabel string

Display label.

radiusPort number

The port that your RADIUS server is using for communications. Your self-managed network must allow inbound traffic over this port from the AWS Directory Service servers.

radiusRetries number

The maximum number of times that communication with the RADIUS server is attempted. Minimum value of 0. Maximum value of 10.

radiusServers string[]

An array of strings that contains the fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.

radiusTimeout number

The amount of time, in seconds, to wait for the RADIUS server to respond. Minimum value of 1. Maximum value of 50.

sharedSecret string

Required for enabling RADIUS on the directory.

useSameUsername boolean

Not currently used.

authentication_protocol str

The protocol specified for your RADIUS endpoints. Valid values: PAP, CHAP, MS-CHAPv1, MS-CHAPv2.

directory_id str

The identifier of the directory for which you want to manager RADIUS settings.

display_label str

Display label.

radius_port int

The port that your RADIUS server is using for communications. Your self-managed network must allow inbound traffic over this port from the AWS Directory Service servers.

radius_retries int

The maximum number of times that communication with the RADIUS server is attempted. Minimum value of 0. Maximum value of 10.

radius_servers Sequence[str]

An array of strings that contains the fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.

radius_timeout int

The amount of time, in seconds, to wait for the RADIUS server to respond. Minimum value of 1. Maximum value of 50.

shared_secret str

Required for enabling RADIUS on the directory.

use_same_username bool

Not currently used.

authenticationProtocol String

The protocol specified for your RADIUS endpoints. Valid values: PAP, CHAP, MS-CHAPv1, MS-CHAPv2.

directoryId String

The identifier of the directory for which you want to manager RADIUS settings.

displayLabel String

Display label.

radiusPort Number

The port that your RADIUS server is using for communications. Your self-managed network must allow inbound traffic over this port from the AWS Directory Service servers.

radiusRetries Number

The maximum number of times that communication with the RADIUS server is attempted. Minimum value of 0. Maximum value of 10.

radiusServers List<String>

An array of strings that contains the fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.

radiusTimeout Number

The amount of time, in seconds, to wait for the RADIUS server to respond. Minimum value of 1. Maximum value of 50.

sharedSecret String

Required for enabling RADIUS on the directory.

useSameUsername Boolean

Not currently used.

Import

RADIUS settings can be imported using the directory ID, e.g.,

 $ pulumi import aws:directoryservice/radiusSettings:RadiusSettings example d-926724cf57

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.