Docs Home
Keycloak v6.5.0 published on Tuesday, May 13, 2025 by Pulumi
keycloak.openid.ClientAggregatePolicy
Explore with Pulumi AI
Create ClientAggregatePolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ClientAggregatePolicy(name: string, args: ClientAggregatePolicyArgs, opts?: CustomResourceOptions);@overload
def ClientAggregatePolicy(resource_name: str,
args: ClientAggregatePolicyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ClientAggregatePolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
decision_strategy: Optional[str] = None,
policies: Optional[Sequence[str]] = None,
realm_id: Optional[str] = None,
resource_server_id: Optional[str] = None,
description: Optional[str] = None,
logic: Optional[str] = None,
name: Optional[str] = None)func NewClientAggregatePolicy(ctx *Context, name string, args ClientAggregatePolicyArgs, opts ...ResourceOption) (*ClientAggregatePolicy, error)public ClientAggregatePolicy(string name, ClientAggregatePolicyArgs args, CustomResourceOptions? opts = null)
public ClientAggregatePolicy(String name, ClientAggregatePolicyArgs args)
public ClientAggregatePolicy(String name, ClientAggregatePolicyArgs args, CustomResourceOptions options)
type: keycloak:openid:ClientAggregatePolicy
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 ClientAggregatePolicyArgs
- 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 ClientAggregatePolicyArgs
- 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 ClientAggregatePolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClientAggregatePolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ClientAggregatePolicyArgs
- 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 clientAggregatePolicyResource = new Keycloak.OpenId.ClientAggregatePolicy("clientAggregatePolicyResource", new()
{
DecisionStrategy = "string",
Policies = new[]
{
"string",
},
RealmId = "string",
ResourceServerId = "string",
Description = "string",
Logic = "string",
Name = "string",
});
example, err := openid.NewClientAggregatePolicy(ctx, "clientAggregatePolicyResource", &openid.ClientAggregatePolicyArgs{
DecisionStrategy: pulumi.String("string"),
Policies: pulumi.StringArray{
pulumi.String("string"),
},
RealmId: pulumi.String("string"),
ResourceServerId: pulumi.String("string"),
Description: pulumi.String("string"),
Logic: pulumi.String("string"),
Name: pulumi.String("string"),
})
var clientAggregatePolicyResource = new ClientAggregatePolicy("clientAggregatePolicyResource", ClientAggregatePolicyArgs.builder()
.decisionStrategy("string")
.policies("string")
.realmId("string")
.resourceServerId("string")
.description("string")
.logic("string")
.name("string")
.build());
client_aggregate_policy_resource = keycloak.openid.ClientAggregatePolicy("clientAggregatePolicyResource",
decision_strategy="string",
policies=["string"],
realm_id="string",
resource_server_id="string",
description="string",
logic="string",
name="string")
const clientAggregatePolicyResource = new keycloak.openid.ClientAggregatePolicy("clientAggregatePolicyResource", {
decisionStrategy: "string",
policies: ["string"],
realmId: "string",
resourceServerId: "string",
description: "string",
logic: "string",
name: "string",
});
type: keycloak:openid:ClientAggregatePolicy
properties:
decisionStrategy: string
description: string
logic: string
name: string
policies:
- string
realmId: string
resourceServerId: string
ClientAggregatePolicy 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 ClientAggregatePolicy resource accepts the following input properties:
- Decision
Strategy string - Policies List<string>
- Realm
Id string - Resource
Server stringId - Description string
- Logic string
- Name string
- Decision
Strategy string - Policies []string
- Realm
Id string - Resource
Server stringId - Description string
- Logic string
- Name string
- decision
Strategy String - policies List<String>
- realm
Id String - resource
Server StringId - description String
- logic String
- name String
- decision
Strategy string - policies string[]
- realm
Id string - resource
Server stringId - description string
- logic string
- name string
- decision_
strategy str - policies Sequence[str]
- realm_
id str - resource_
server_ strid - description str
- logic str
- name str
- decision
Strategy String - policies List<String>
- realm
Id String - resource
Server StringId - description String
- logic String
- name String
Outputs
All input properties are implicitly available as output properties. Additionally, the ClientAggregatePolicy 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 ClientAggregatePolicy Resource
Get an existing ClientAggregatePolicy 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?: ClientAggregatePolicyState, opts?: CustomResourceOptions): ClientAggregatePolicy@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
decision_strategy: Optional[str] = None,
description: Optional[str] = None,
logic: Optional[str] = None,
name: Optional[str] = None,
policies: Optional[Sequence[str]] = None,
realm_id: Optional[str] = None,
resource_server_id: Optional[str] = None) -> ClientAggregatePolicyfunc GetClientAggregatePolicy(ctx *Context, name string, id IDInput, state *ClientAggregatePolicyState, opts ...ResourceOption) (*ClientAggregatePolicy, error)public static ClientAggregatePolicy Get(string name, Input<string> id, ClientAggregatePolicyState? state, CustomResourceOptions? opts = null)public static ClientAggregatePolicy get(String name, Output<String> id, ClientAggregatePolicyState state, CustomResourceOptions options)resources: _: type: keycloak:openid:ClientAggregatePolicy 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.
- Decision
Strategy string - Description string
- Logic string
- Name string
- Policies List<string>
- Realm
Id string - Resource
Server stringId
- Decision
Strategy string - Description string
- Logic string
- Name string
- Policies []string
- Realm
Id string - Resource
Server stringId
- decision
Strategy String - description String
- logic String
- name String
- policies List<String>
- realm
Id String - resource
Server StringId
- decision
Strategy string - description string
- logic string
- name string
- policies string[]
- realm
Id string - resource
Server stringId
- decision_
strategy str - description str
- logic str
- name str
- policies Sequence[str]
- realm_
id str - resource_
server_ strid
- decision
Strategy String - description String
- logic String
- name String
- policies List<String>
- realm
Id String - resource
Server StringId
Package Details
- Repository
- Keycloak pulumi/pulumi-keycloak
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
keycloakTerraform Provider.