1. Packages
  2. Akeyless Provider
  3. API Docs
  4. AssociateRoleAuthMethod
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community

akeyless.AssociateRoleAuthMethod

Explore with Pulumi AI

akeyless logo
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community

    Association between role and auth method

    Create AssociateRoleAuthMethod Resource

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

    Constructor syntax

    new AssociateRoleAuthMethod(name: string, args: AssociateRoleAuthMethodArgs, opts?: CustomResourceOptions);
    @overload
    def AssociateRoleAuthMethod(resource_name: str,
                                args: AssociateRoleAuthMethodArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def AssociateRoleAuthMethod(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                am_name: Optional[str] = None,
                                role_name: Optional[str] = None,
                                associate_role_auth_method_id: Optional[str] = None,
                                case_sensitive: Optional[str] = None,
                                sub_claims: Optional[Mapping[str, str]] = None)
    func NewAssociateRoleAuthMethod(ctx *Context, name string, args AssociateRoleAuthMethodArgs, opts ...ResourceOption) (*AssociateRoleAuthMethod, error)
    public AssociateRoleAuthMethod(string name, AssociateRoleAuthMethodArgs args, CustomResourceOptions? opts = null)
    public AssociateRoleAuthMethod(String name, AssociateRoleAuthMethodArgs args)
    public AssociateRoleAuthMethod(String name, AssociateRoleAuthMethodArgs args, CustomResourceOptions options)
    
    type: akeyless:AssociateRoleAuthMethod
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AssociateRoleAuthMethodArgs
    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 AssociateRoleAuthMethodArgs
    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 AssociateRoleAuthMethodArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AssociateRoleAuthMethodArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AssociateRoleAuthMethodArgs
    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 associateRoleAuthMethodResource = new Akeyless.AssociateRoleAuthMethod("associateRoleAuthMethodResource", new()
    {
        AmName = "string",
        RoleName = "string",
        AssociateRoleAuthMethodId = "string",
        CaseSensitive = "string",
        SubClaims = 
        {
            { "string", "string" },
        },
    });
    
    example, err := akeyless.NewAssociateRoleAuthMethod(ctx, "associateRoleAuthMethodResource", &akeyless.AssociateRoleAuthMethodArgs{
    	AmName:                    pulumi.String("string"),
    	RoleName:                  pulumi.String("string"),
    	AssociateRoleAuthMethodId: pulumi.String("string"),
    	CaseSensitive:             pulumi.String("string"),
    	SubClaims: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var associateRoleAuthMethodResource = new AssociateRoleAuthMethod("associateRoleAuthMethodResource", AssociateRoleAuthMethodArgs.builder()
        .amName("string")
        .roleName("string")
        .associateRoleAuthMethodId("string")
        .caseSensitive("string")
        .subClaims(Map.of("string", "string"))
        .build());
    
    associate_role_auth_method_resource = akeyless.AssociateRoleAuthMethod("associateRoleAuthMethodResource",
        am_name="string",
        role_name="string",
        associate_role_auth_method_id="string",
        case_sensitive="string",
        sub_claims={
            "string": "string",
        })
    
    const associateRoleAuthMethodResource = new akeyless.AssociateRoleAuthMethod("associateRoleAuthMethodResource", {
        amName: "string",
        roleName: "string",
        associateRoleAuthMethodId: "string",
        caseSensitive: "string",
        subClaims: {
            string: "string",
        },
    });
    
    type: akeyless:AssociateRoleAuthMethod
    properties:
        amName: string
        associateRoleAuthMethodId: string
        caseSensitive: string
        roleName: string
        subClaims:
            string: string
    

    AssociateRoleAuthMethod 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 AssociateRoleAuthMethod resource accepts the following input properties:

    AmName string
    The auth method to associate
    RoleName string
    The role to associate
    AssociateRoleAuthMethodId string
    The ID of this resource.
    CaseSensitive string
    Treat sub claims as case-sensitive
    SubClaims Dictionary<string, string>
    key/val of sub claims, e.g group=admins,developers
    AmName string
    The auth method to associate
    RoleName string
    The role to associate
    AssociateRoleAuthMethodId string
    The ID of this resource.
    CaseSensitive string
    Treat sub claims as case-sensitive
    SubClaims map[string]string
    key/val of sub claims, e.g group=admins,developers
    amName String
    The auth method to associate
    roleName String
    The role to associate
    associateRoleAuthMethodId String
    The ID of this resource.
    caseSensitive String
    Treat sub claims as case-sensitive
    subClaims Map<String,String>
    key/val of sub claims, e.g group=admins,developers
    amName string
    The auth method to associate
    roleName string
    The role to associate
    associateRoleAuthMethodId string
    The ID of this resource.
    caseSensitive string
    Treat sub claims as case-sensitive
    subClaims {[key: string]: string}
    key/val of sub claims, e.g group=admins,developers
    am_name str
    The auth method to associate
    role_name str
    The role to associate
    associate_role_auth_method_id str
    The ID of this resource.
    case_sensitive str
    Treat sub claims as case-sensitive
    sub_claims Mapping[str, str]
    key/val of sub claims, e.g group=admins,developers
    amName String
    The auth method to associate
    roleName String
    The role to associate
    associateRoleAuthMethodId String
    The ID of this resource.
    caseSensitive String
    Treat sub claims as case-sensitive
    subClaims Map<String>
    key/val of sub claims, e.g group=admins,developers

    Outputs

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

    Get an existing AssociateRoleAuthMethod 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?: AssociateRoleAuthMethodState, opts?: CustomResourceOptions): AssociateRoleAuthMethod
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            am_name: Optional[str] = None,
            associate_role_auth_method_id: Optional[str] = None,
            case_sensitive: Optional[str] = None,
            role_name: Optional[str] = None,
            sub_claims: Optional[Mapping[str, str]] = None) -> AssociateRoleAuthMethod
    func GetAssociateRoleAuthMethod(ctx *Context, name string, id IDInput, state *AssociateRoleAuthMethodState, opts ...ResourceOption) (*AssociateRoleAuthMethod, error)
    public static AssociateRoleAuthMethod Get(string name, Input<string> id, AssociateRoleAuthMethodState? state, CustomResourceOptions? opts = null)
    public static AssociateRoleAuthMethod get(String name, Output<String> id, AssociateRoleAuthMethodState state, CustomResourceOptions options)
    resources:  _:    type: akeyless:AssociateRoleAuthMethod    get:      id: ${id}
    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:
    AmName string
    The auth method to associate
    AssociateRoleAuthMethodId string
    The ID of this resource.
    CaseSensitive string
    Treat sub claims as case-sensitive
    RoleName string
    The role to associate
    SubClaims Dictionary<string, string>
    key/val of sub claims, e.g group=admins,developers
    AmName string
    The auth method to associate
    AssociateRoleAuthMethodId string
    The ID of this resource.
    CaseSensitive string
    Treat sub claims as case-sensitive
    RoleName string
    The role to associate
    SubClaims map[string]string
    key/val of sub claims, e.g group=admins,developers
    amName String
    The auth method to associate
    associateRoleAuthMethodId String
    The ID of this resource.
    caseSensitive String
    Treat sub claims as case-sensitive
    roleName String
    The role to associate
    subClaims Map<String,String>
    key/val of sub claims, e.g group=admins,developers
    amName string
    The auth method to associate
    associateRoleAuthMethodId string
    The ID of this resource.
    caseSensitive string
    Treat sub claims as case-sensitive
    roleName string
    The role to associate
    subClaims {[key: string]: string}
    key/val of sub claims, e.g group=admins,developers
    am_name str
    The auth method to associate
    associate_role_auth_method_id str
    The ID of this resource.
    case_sensitive str
    Treat sub claims as case-sensitive
    role_name str
    The role to associate
    sub_claims Mapping[str, str]
    key/val of sub claims, e.g group=admins,developers
    amName String
    The auth method to associate
    associateRoleAuthMethodId String
    The ID of this resource.
    caseSensitive String
    Treat sub claims as case-sensitive
    roleName String
    The role to associate
    subClaims Map<String>
    key/val of sub claims, e.g group=admins,developers

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    akeyless logo
    akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community