RadiusSettings class

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.directoryservice.RadiusSettings("example", {
    directoryId: exampleAwsDirectoryServiceDirectory.id,
    authenticationProtocol: "PAP",
    displayLabel: "example",
    radiusPort: 1812,
    radiusRetries: 4,
    radiusServers: ["10.0.1.5"],
    radiusTimeout: 1,
    sharedSecret: "12345678",
});
import pulumi
import pulumi_aws as aws

example = aws.directoryservice.RadiusSettings("example",
    directory_id=example_aws_directory_service_directory["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")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.DirectoryService.RadiusSettings("example", new()
    {
        DirectoryId = exampleAwsDirectoryServiceDirectory.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/v7/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(exampleAwsDirectoryServiceDirectory.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
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_directoryservice_radiussettings" "example" {
  directory_id            = exampleAwsDirectoryServiceDirectory.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"
}
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.ArrayList;
import java.util.Arrays;
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(exampleAwsDirectoryServiceDirectory.id())
            .authenticationProtocol("PAP")
            .displayLabel("example")
            .radiusPort(1812)
            .radiusRetries(4)
            .radiusServers("10.0.1.5")
            .radiusTimeout(1)
            .sharedSecret("12345678")
            .build());

    }
}
resources:
  example:
    type: aws:directoryservice:RadiusSettings
    properties:
      directoryId: ${exampleAwsDirectoryServiceDirectory.id}
      authenticationProtocol: PAP
      displayLabel: example
      radiusPort: 1812
      radiusRetries: 4
      radiusServers:
        - 10.0.1.5
      radiusTimeout: 1
      sharedSecret: '12345678'

Import

Using pulumi import, import RADIUS settings using the directory ID. For example:

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

Constructors

RadiusSettings(String name, {RadiusSettingsArgs? args, CustomResourceOptions? options})
Creates a new RadiusSettings. name The Pulumi resource name. args Arguments used to configure this RadiusSettings. The set of arguments for RadiusSettings. options Resource options controlling this resource's behavior.
RadiusSettings.reference(String urn)
Creates a typed reference to an existing RadiusSettings resource.

Properties

authenticationProtocol ↔ Output<String>
The protocol specified for your RADIUS endpoints. Valid values: PAP, CHAP, MS-CHAPv1, MS-CHAPv2.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
directoryId ↔ Output<String>
The identifier of the directory for which you want to manager RADIUS settings.
latefinal
displayLabel ↔ Output<String>
Display label.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
radiusPort ↔ Output<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.
latefinal
radiusRetries ↔ Output<int>
The maximum number of times that communication with the RADIUS server is attempted. Minimum value of 0. Maximum value of 10.
latefinal
radiusServers ↔ Output<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.
latefinal
radiusTimeout ↔ Output<int>
The amount of time, in seconds, to wait for the RADIUS server to respond. Minimum value of 1. Maximum value of 50.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sharedSecret ↔ Output<String>
Required for enabling RADIUS on the directory.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
useSameUsername ↔ Output<bool?>
Not currently used.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {RadiusSettingsState? state, CustomResourceOptions? options}) → RadiusSettings
Gets an existing RadiusSettings resource's state with the given name and id.