Docs Home
Keycloak v6.4.0 published on Wednesday, Apr 16, 2025 by Pulumi
keycloak.RealmLocalization
Explore with Pulumi AI
Create RealmLocalization Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RealmLocalization(name: string, args: RealmLocalizationArgs, opts?: CustomResourceOptions);@overload
def RealmLocalization(resource_name: str,
args: RealmLocalizationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def RealmLocalization(resource_name: str,
opts: Optional[ResourceOptions] = None,
locale: Optional[str] = None,
realm_id: Optional[str] = None,
texts: Optional[Mapping[str, str]] = None)func NewRealmLocalization(ctx *Context, name string, args RealmLocalizationArgs, opts ...ResourceOption) (*RealmLocalization, error)public RealmLocalization(string name, RealmLocalizationArgs args, CustomResourceOptions? opts = null)public RealmLocalization(String name, RealmLocalizationArgs args)
public RealmLocalization(String name, RealmLocalizationArgs args, CustomResourceOptions options)
type: keycloak:RealmLocalization
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. RealmLocalizationArgs - 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. RealmLocalizationArgs - 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. RealmLocalizationArgs - 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. RealmLocalizationArgs - 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. RealmLocalizationArgs - 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 realmLocalizationResource = new Keycloak.RealmLocalization("realmLocalizationResource", new()
{
Locale = "string",
RealmId = "string",
Texts =
{
{ "string", "string" },
},
});
example, err := keycloak.NewRealmLocalization(ctx, "realmLocalizationResource", &keycloak.RealmLocalizationArgs{
Locale: pulumi.String("string"),
RealmId: pulumi.String("string"),
Texts: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var realmLocalizationResource = new RealmLocalization("realmLocalizationResource", RealmLocalizationArgs.builder()
.locale("string")
.realmId("string")
.texts(Map.of("string", "string"))
.build());
realm_localization_resource = keycloak.RealmLocalization("realmLocalizationResource",
locale="string",
realm_id="string",
texts={
"string": "string",
})
const realmLocalizationResource = new keycloak.RealmLocalization("realmLocalizationResource", {
locale: "string",
realmId: "string",
texts: {
string: "string",
},
});
type: keycloak:RealmLocalization
properties:
locale: string
realmId: string
texts:
string: string
RealmLocalization 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 RealmLocalization resource accepts the following input properties:
- Locale
string
This property is required. 
Changes to this property will trigger replacement. - The locale for the localization texts.
- Realm
Id stringThis property is required. Changes to this property will trigger replacement. - The realm in which the texts exists.
- Texts Dictionary<string, string>
- The mapping of localization texts keys to values.
- Locale
string
This property is required. Changes to this property will trigger replacement. - The locale for the localization texts.
- Realm
Id stringThis property is required. Changes to this property will trigger replacement. - The realm in which the texts exists.
- Texts map[string]string
- The mapping of localization texts keys to values.
- locale
String
This property is required. Changes to this property will trigger replacement. - The locale for the localization texts.
- realm
Id StringThis property is required. Changes to this property will trigger replacement. - The realm in which the texts exists.
- texts Map<String,String>
- The mapping of localization texts keys to values.
- locale
string
This property is required. Changes to this property will trigger replacement. - The locale for the localization texts.
- realm
Id stringThis property is required. Changes to this property will trigger replacement. - The realm in which the texts exists.
- texts {[key: string]: string}
- The mapping of localization texts keys to values.
- locale
str
This property is required. Changes to this property will trigger replacement. - The locale for the localization texts.
- realm_
id strThis property is required. Changes to this property will trigger replacement. - The realm in which the texts exists.
- texts Mapping[str, str]
- The mapping of localization texts keys to values.
- locale
String
This property is required. Changes to this property will trigger replacement. - The locale for the localization texts.
- realm
Id StringThis property is required. Changes to this property will trigger replacement. - The realm in which the texts exists.
- texts Map<String>
- The mapping of localization texts keys to values.
Outputs
All input properties are implicitly available as output properties. Additionally, the RealmLocalization 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 RealmLocalization Resource
Get an existing RealmLocalization 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?: RealmLocalizationState, opts?: CustomResourceOptions): RealmLocalization@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
locale: Optional[str] = None,
realm_id: Optional[str] = None,
texts: Optional[Mapping[str, str]] = None) -> RealmLocalizationfunc GetRealmLocalization(ctx *Context, name string, id IDInput, state *RealmLocalizationState, opts ...ResourceOption) (*RealmLocalization, error)public static RealmLocalization Get(string name, Input<string> id, RealmLocalizationState? state, CustomResourceOptions? opts = null)public static RealmLocalization get(String name, Output<String> id, RealmLocalizationState state, CustomResourceOptions options)resources: _: type: keycloak:RealmLocalization 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:
Package Details
- Repository
- Keycloak pulumi/pulumi-keycloak
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
keycloakTerraform Provider.