keycloak.RealmClientPolicyProfile
Explore with Pulumi AI
Allows for managing Realm Client Policy Profiles.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as keycloak from "@pulumi/keycloak";
const realm = new keycloak.Realm("realm", {realm: "my-realm"});
const profile = new keycloak.RealmClientPolicyProfile("profile", {
name: "my-profile",
realmId: realm.id,
executors: [
{
name: "intent-client-bind-checker",
configuration: {
"auto-configure": "true",
},
},
{
name: "secure-session",
},
],
});
import pulumi
import pulumi_keycloak as keycloak
realm = keycloak.Realm("realm", realm="my-realm")
profile = keycloak.RealmClientPolicyProfile("profile",
name="my-profile",
realm_id=realm.id,
executors=[
{
"name": "intent-client-bind-checker",
"configuration": {
"auto-configure": "true",
},
},
{
"name": "secure-session",
},
])
package main
import (
"github.com/pulumi/pulumi-keycloak/sdk/v6/go/keycloak"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
realm, err := keycloak.NewRealm(ctx, "realm", &keycloak.RealmArgs{
Realm: pulumi.String("my-realm"),
})
if err != nil {
return err
}
_, err = keycloak.NewRealmClientPolicyProfile(ctx, "profile", &keycloak.RealmClientPolicyProfileArgs{
Name: pulumi.String("my-profile"),
RealmId: realm.ID(),
Executors: keycloak.RealmClientPolicyProfileExecutorArray{
&keycloak.RealmClientPolicyProfileExecutorArgs{
Name: pulumi.String("intent-client-bind-checker"),
Configuration: pulumi.StringMap{
"auto-configure": pulumi.String("true"),
},
},
&keycloak.RealmClientPolicyProfileExecutorArgs{
Name: pulumi.String("secure-session"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Keycloak = Pulumi.Keycloak;
return await Deployment.RunAsync(() =>
{
var realm = new Keycloak.Realm("realm", new()
{
RealmName = "my-realm",
});
var profile = new Keycloak.RealmClientPolicyProfile("profile", new()
{
Name = "my-profile",
RealmId = realm.Id,
Executors = new[]
{
new Keycloak.Inputs.RealmClientPolicyProfileExecutorArgs
{
Name = "intent-client-bind-checker",
Configuration =
{
{ "auto-configure", "true" },
},
},
new Keycloak.Inputs.RealmClientPolicyProfileExecutorArgs
{
Name = "secure-session",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.keycloak.Realm;
import com.pulumi.keycloak.RealmArgs;
import com.pulumi.keycloak.RealmClientPolicyProfile;
import com.pulumi.keycloak.RealmClientPolicyProfileArgs;
import com.pulumi.keycloak.inputs.RealmClientPolicyProfileExecutorArgs;
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 realm = new Realm("realm", RealmArgs.builder()
.realm("my-realm")
.build());
var profile = new RealmClientPolicyProfile("profile", RealmClientPolicyProfileArgs.builder()
.name("my-profile")
.realmId(realm.id())
.executors(
RealmClientPolicyProfileExecutorArgs.builder()
.name("intent-client-bind-checker")
.configuration(Map.of("auto-configure", "true"))
.build(),
RealmClientPolicyProfileExecutorArgs.builder()
.name("secure-session")
.build())
.build());
}
}
resources:
realm:
type: keycloak:Realm
properties:
realm: my-realm
profile:
type: keycloak:RealmClientPolicyProfile
properties:
name: my-profile
realmId: ${realm.id}
executors:
- name: intent-client-bind-checker
configuration:
auto-configure: true
- name: secure-session
Attribute Arguments
name
- (Required) The name of the attribute.realm_id
- (Required) The realm id.executor
- (Optional) An ordered list of executors
Executor Arguments
name
- (Required) The name of the executor. NOTE! The executor needs to existconfiguration
- (Optional) - A map of configuration values
Create RealmClientPolicyProfile Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RealmClientPolicyProfile(name: string, args: RealmClientPolicyProfileArgs, opts?: CustomResourceOptions);
@overload
def RealmClientPolicyProfile(resource_name: str,
args: RealmClientPolicyProfileArgs,
opts: Optional[ResourceOptions] = None)
@overload
def RealmClientPolicyProfile(resource_name: str,
opts: Optional[ResourceOptions] = None,
realm_id: Optional[str] = None,
description: Optional[str] = None,
executors: Optional[Sequence[RealmClientPolicyProfileExecutorArgs]] = None,
name: Optional[str] = None)
func NewRealmClientPolicyProfile(ctx *Context, name string, args RealmClientPolicyProfileArgs, opts ...ResourceOption) (*RealmClientPolicyProfile, error)
public RealmClientPolicyProfile(string name, RealmClientPolicyProfileArgs args, CustomResourceOptions? opts = null)
public RealmClientPolicyProfile(String name, RealmClientPolicyProfileArgs args)
public RealmClientPolicyProfile(String name, RealmClientPolicyProfileArgs args, CustomResourceOptions options)
type: keycloak:RealmClientPolicyProfile
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 RealmClientPolicyProfileArgs
- 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 RealmClientPolicyProfileArgs
- 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 RealmClientPolicyProfileArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RealmClientPolicyProfileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RealmClientPolicyProfileArgs
- 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 realmClientPolicyProfileResource = new Keycloak.RealmClientPolicyProfile("realmClientPolicyProfileResource", new()
{
RealmId = "string",
Description = "string",
Executors = new[]
{
new Keycloak.Inputs.RealmClientPolicyProfileExecutorArgs
{
Name = "string",
Configuration =
{
{ "string", "string" },
},
},
},
Name = "string",
});
example, err := keycloak.NewRealmClientPolicyProfile(ctx, "realmClientPolicyProfileResource", &keycloak.RealmClientPolicyProfileArgs{
RealmId: pulumi.String("string"),
Description: pulumi.String("string"),
Executors: keycloak.RealmClientPolicyProfileExecutorArray{
&keycloak.RealmClientPolicyProfileExecutorArgs{
Name: pulumi.String("string"),
Configuration: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
},
Name: pulumi.String("string"),
})
var realmClientPolicyProfileResource = new RealmClientPolicyProfile("realmClientPolicyProfileResource", RealmClientPolicyProfileArgs.builder()
.realmId("string")
.description("string")
.executors(RealmClientPolicyProfileExecutorArgs.builder()
.name("string")
.configuration(Map.of("string", "string"))
.build())
.name("string")
.build());
realm_client_policy_profile_resource = keycloak.RealmClientPolicyProfile("realmClientPolicyProfileResource",
realm_id="string",
description="string",
executors=[{
"name": "string",
"configuration": {
"string": "string",
},
}],
name="string")
const realmClientPolicyProfileResource = new keycloak.RealmClientPolicyProfile("realmClientPolicyProfileResource", {
realmId: "string",
description: "string",
executors: [{
name: "string",
configuration: {
string: "string",
},
}],
name: "string",
});
type: keycloak:RealmClientPolicyProfile
properties:
description: string
executors:
- configuration:
string: string
name: string
name: string
realmId: string
RealmClientPolicyProfile 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 RealmClientPolicyProfile resource accepts the following input properties:
- Realm
Id string - Description string
- Executors
List<Realm
Client Policy Profile Executor> - Name string
- Realm
Id string - Description string
- Executors
[]Realm
Client Policy Profile Executor Args - Name string
- realm
Id String - description String
- executors
List<Realm
Client Policy Profile Executor> - name String
- realm
Id string - description string
- executors
Realm
Client Policy Profile Executor[] - name string
- realm
Id String - description String
- executors List<Property Map>
- name String
Outputs
All input properties are implicitly available as output properties. Additionally, the RealmClientPolicyProfile 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 RealmClientPolicyProfile Resource
Get an existing RealmClientPolicyProfile 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?: RealmClientPolicyProfileState, opts?: CustomResourceOptions): RealmClientPolicyProfile
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
executors: Optional[Sequence[RealmClientPolicyProfileExecutorArgs]] = None,
name: Optional[str] = None,
realm_id: Optional[str] = None) -> RealmClientPolicyProfile
func GetRealmClientPolicyProfile(ctx *Context, name string, id IDInput, state *RealmClientPolicyProfileState, opts ...ResourceOption) (*RealmClientPolicyProfile, error)
public static RealmClientPolicyProfile Get(string name, Input<string> id, RealmClientPolicyProfileState? state, CustomResourceOptions? opts = null)
public static RealmClientPolicyProfile get(String name, Output<String> id, RealmClientPolicyProfileState state, CustomResourceOptions options)
resources: _: type: keycloak:RealmClientPolicyProfile 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.
- Description string
- Executors
List<Realm
Client Policy Profile Executor> - Name string
- Realm
Id string
- Description string
- Executors
[]Realm
Client Policy Profile Executor Args - Name string
- Realm
Id string
- description String
- executors
List<Realm
Client Policy Profile Executor> - name String
- realm
Id String
- description string
- executors
Realm
Client Policy Profile Executor[] - name string
- realm
Id string
- description String
- executors List<Property Map>
- name String
- realm
Id String
Supporting Types
RealmClientPolicyProfileExecutor, RealmClientPolicyProfileExecutorArgs
- Name string
- Configuration Dictionary<string, string>
- Name string
- Configuration map[string]string
- name String
- configuration Map<String,String>
- name string
- configuration {[key: string]: string}
- name str
- configuration Mapping[str, str]
- name String
- configuration Map<String>
Import
This resource currently does not support importing.
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Keycloak pulumi/pulumi-keycloak
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
keycloak
Terraform Provider.