1. Packages
  2. Aviatrix
  3. API Docs
  4. AviatrixRbacGroup
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix

aviatrix.AviatrixRbacGroup

Explore with Pulumi AI

The aviatrix_rbac_group resource allows the creation and management of Aviatrix (Role-Based Access Control) RBAC groups.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    // Create an Aviatrix RBAC Group
    var testGroup = new Aviatrix.AviatrixRbacGroup("testGroup", new()
    {
        GroupName = "write_only",
    });

});
Copy
package main

import (
	"github.com/astipkovits/pulumi-aviatrix/sdk/go/aviatrix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aviatrix.NewAviatrixRbacGroup(ctx, "testGroup", &aviatrix.AviatrixRbacGroupArgs{
			GroupName: pulumi.String("write_only"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aviatrix.AviatrixRbacGroup;
import com.pulumi.aviatrix.AviatrixRbacGroupArgs;
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 testGroup = new AviatrixRbacGroup("testGroup", AviatrixRbacGroupArgs.builder()        
            .groupName("write_only")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as aviatrix from "@pulumi/aviatrix";

// Create an Aviatrix RBAC Group
const testGroup = new aviatrix.AviatrixRbacGroup("test_group", {
    groupName: "write_only",
});
Copy
import pulumi
import pulumi_aviatrix as aviatrix

# Create an Aviatrix RBAC Group
test_group = aviatrix.AviatrixRbacGroup("testGroup", group_name="write_only")
Copy
resources:
  # Create an Aviatrix RBAC Group
  testGroup:
    type: aviatrix:AviatrixRbacGroup
    properties:
      groupName: write_only
Copy

Create AviatrixRbacGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new AviatrixRbacGroup(name: string, args: AviatrixRbacGroupArgs, opts?: CustomResourceOptions);
@overload
def AviatrixRbacGroup(resource_name: str,
                      args: AviatrixRbacGroupArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def AviatrixRbacGroup(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      group_name: Optional[str] = None,
                      local_login: Optional[bool] = None)
func NewAviatrixRbacGroup(ctx *Context, name string, args AviatrixRbacGroupArgs, opts ...ResourceOption) (*AviatrixRbacGroup, error)
public AviatrixRbacGroup(string name, AviatrixRbacGroupArgs args, CustomResourceOptions? opts = null)
public AviatrixRbacGroup(String name, AviatrixRbacGroupArgs args)
public AviatrixRbacGroup(String name, AviatrixRbacGroupArgs args, CustomResourceOptions options)
type: aviatrix:AviatrixRbacGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

The following reference example uses placeholder values for all input properties.

var aviatrixRbacGroupResource = new Aviatrix.AviatrixRbacGroup("aviatrixRbacGroupResource", new()
{
    GroupName = "string",
    LocalLogin = false,
});
Copy
example, err := aviatrix.NewAviatrixRbacGroup(ctx, "aviatrixRbacGroupResource", &aviatrix.AviatrixRbacGroupArgs{
	GroupName:  pulumi.String("string"),
	LocalLogin: pulumi.Bool(false),
})
Copy
var aviatrixRbacGroupResource = new AviatrixRbacGroup("aviatrixRbacGroupResource", AviatrixRbacGroupArgs.builder()
    .groupName("string")
    .localLogin(false)
    .build());
Copy
aviatrix_rbac_group_resource = aviatrix.AviatrixRbacGroup("aviatrixRbacGroupResource",
    group_name="string",
    local_login=False)
Copy
const aviatrixRbacGroupResource = new aviatrix.AviatrixRbacGroup("aviatrixRbacGroupResource", {
    groupName: "string",
    localLogin: false,
});
Copy
type: aviatrix:AviatrixRbacGroup
properties:
    groupName: string
    localLogin: false
Copy

AviatrixRbacGroup Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AviatrixRbacGroup resource accepts the following input properties:

GroupName
This property is required.
Changes to this property will trigger replacement.
string
This parameter represents the name of a RBAC group to be created.
LocalLogin bool
Whether to allow members of an RBAC group to bypass LDAP/MFA for Duo login . Supported values: true, false. Default value: false. Available in provider version R2.17.1+.
GroupName
This property is required.
Changes to this property will trigger replacement.
string
This parameter represents the name of a RBAC group to be created.
LocalLogin bool
Whether to allow members of an RBAC group to bypass LDAP/MFA for Duo login . Supported values: true, false. Default value: false. Available in provider version R2.17.1+.
groupName
This property is required.
Changes to this property will trigger replacement.
String
This parameter represents the name of a RBAC group to be created.
localLogin Boolean
Whether to allow members of an RBAC group to bypass LDAP/MFA for Duo login . Supported values: true, false. Default value: false. Available in provider version R2.17.1+.
groupName
This property is required.
Changes to this property will trigger replacement.
string
This parameter represents the name of a RBAC group to be created.
localLogin boolean
Whether to allow members of an RBAC group to bypass LDAP/MFA for Duo login . Supported values: true, false. Default value: false. Available in provider version R2.17.1+.
group_name
This property is required.
Changes to this property will trigger replacement.
str
This parameter represents the name of a RBAC group to be created.
local_login bool
Whether to allow members of an RBAC group to bypass LDAP/MFA for Duo login . Supported values: true, false. Default value: false. Available in provider version R2.17.1+.
groupName
This property is required.
Changes to this property will trigger replacement.
String
This parameter represents the name of a RBAC group to be created.
localLogin Boolean
Whether to allow members of an RBAC group to bypass LDAP/MFA for Duo login . Supported values: true, false. Default value: false. Available in provider version R2.17.1+.

Outputs

All input properties are implicitly available as output properties. Additionally, the AviatrixRbacGroup 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 AviatrixRbacGroup Resource

Get an existing AviatrixRbacGroup 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?: AviatrixRbacGroupState, opts?: CustomResourceOptions): AviatrixRbacGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        group_name: Optional[str] = None,
        local_login: Optional[bool] = None) -> AviatrixRbacGroup
func GetAviatrixRbacGroup(ctx *Context, name string, id IDInput, state *AviatrixRbacGroupState, opts ...ResourceOption) (*AviatrixRbacGroup, error)
public static AviatrixRbacGroup Get(string name, Input<string> id, AviatrixRbacGroupState? state, CustomResourceOptions? opts = null)
public static AviatrixRbacGroup get(String name, Output<String> id, AviatrixRbacGroupState state, CustomResourceOptions options)
resources:  _:    type: aviatrix:AviatrixRbacGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
GroupName Changes to this property will trigger replacement. string
This parameter represents the name of a RBAC group to be created.
LocalLogin bool
Whether to allow members of an RBAC group to bypass LDAP/MFA for Duo login . Supported values: true, false. Default value: false. Available in provider version R2.17.1+.
GroupName Changes to this property will trigger replacement. string
This parameter represents the name of a RBAC group to be created.
LocalLogin bool
Whether to allow members of an RBAC group to bypass LDAP/MFA for Duo login . Supported values: true, false. Default value: false. Available in provider version R2.17.1+.
groupName Changes to this property will trigger replacement. String
This parameter represents the name of a RBAC group to be created.
localLogin Boolean
Whether to allow members of an RBAC group to bypass LDAP/MFA for Duo login . Supported values: true, false. Default value: false. Available in provider version R2.17.1+.
groupName Changes to this property will trigger replacement. string
This parameter represents the name of a RBAC group to be created.
localLogin boolean
Whether to allow members of an RBAC group to bypass LDAP/MFA for Duo login . Supported values: true, false. Default value: false. Available in provider version R2.17.1+.
group_name Changes to this property will trigger replacement. str
This parameter represents the name of a RBAC group to be created.
local_login bool
Whether to allow members of an RBAC group to bypass LDAP/MFA for Duo login . Supported values: true, false. Default value: false. Available in provider version R2.17.1+.
groupName Changes to this property will trigger replacement. String
This parameter represents the name of a RBAC group to be created.
localLogin Boolean
Whether to allow members of an RBAC group to bypass LDAP/MFA for Duo login . Supported values: true, false. Default value: false. Available in provider version R2.17.1+.

Import

rbac_group can be imported using the group_name, e.g.

 $ pulumi import aviatrix:index/aviatrixRbacGroup:AviatrixRbacGroup test group_name
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
aviatrix astipkovits/pulumi-aviatrix
License
Apache-2.0
Notes
This Pulumi package is based on the aviatrix Terraform Provider.