Docs Home
Keycloak v5.3.5 published on Wednesday, Oct 16, 2024 by Pulumi
keycloak.openid.ClientTimePolicy
Explore with Pulumi AI
Create ClientTimePolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ClientTimePolicy(name: string, args: ClientTimePolicyArgs, opts?: CustomResourceOptions);@overload
def ClientTimePolicy(resource_name: str,
args: ClientTimePolicyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ClientTimePolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
realm_id: Optional[str] = None,
resource_server_id: Optional[str] = None,
decision_strategy: Optional[str] = None,
minute_end: Optional[str] = None,
month_end: Optional[str] = None,
hour_end: Optional[str] = None,
logic: Optional[str] = None,
minute: Optional[str] = None,
day_month: Optional[str] = None,
month: Optional[str] = None,
hour: Optional[str] = None,
name: Optional[str] = None,
not_before: Optional[str] = None,
not_on_or_after: Optional[str] = None,
description: Optional[str] = None,
day_month_end: Optional[str] = None,
year: Optional[str] = None,
year_end: Optional[str] = None)func NewClientTimePolicy(ctx *Context, name string, args ClientTimePolicyArgs, opts ...ResourceOption) (*ClientTimePolicy, error)public ClientTimePolicy(string name, ClientTimePolicyArgs args, CustomResourceOptions? opts = null)
public ClientTimePolicy(String name, ClientTimePolicyArgs args)
public ClientTimePolicy(String name, ClientTimePolicyArgs args, CustomResourceOptions options)
type: keycloak:openid:ClientTimePolicy
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 ClientTimePolicyArgs
- 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 ClientTimePolicyArgs
- 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 ClientTimePolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClientTimePolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ClientTimePolicyArgs
- 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 clientTimePolicyResource = new Keycloak.OpenId.ClientTimePolicy("clientTimePolicyResource", new()
{
RealmId = "string",
ResourceServerId = "string",
DecisionStrategy = "string",
MinuteEnd = "string",
MonthEnd = "string",
HourEnd = "string",
Logic = "string",
Minute = "string",
DayMonth = "string",
Month = "string",
Hour = "string",
Name = "string",
NotBefore = "string",
NotOnOrAfter = "string",
Description = "string",
DayMonthEnd = "string",
Year = "string",
YearEnd = "string",
});
example, err := openid.NewClientTimePolicy(ctx, "clientTimePolicyResource", &openid.ClientTimePolicyArgs{
RealmId: pulumi.String("string"),
ResourceServerId: pulumi.String("string"),
DecisionStrategy: pulumi.String("string"),
MinuteEnd: pulumi.String("string"),
MonthEnd: pulumi.String("string"),
HourEnd: pulumi.String("string"),
Logic: pulumi.String("string"),
Minute: pulumi.String("string"),
DayMonth: pulumi.String("string"),
Month: pulumi.String("string"),
Hour: pulumi.String("string"),
Name: pulumi.String("string"),
NotBefore: pulumi.String("string"),
NotOnOrAfter: pulumi.String("string"),
Description: pulumi.String("string"),
DayMonthEnd: pulumi.String("string"),
Year: pulumi.String("string"),
YearEnd: pulumi.String("string"),
})
var clientTimePolicyResource = new ClientTimePolicy("clientTimePolicyResource", ClientTimePolicyArgs.builder()
.realmId("string")
.resourceServerId("string")
.decisionStrategy("string")
.minuteEnd("string")
.monthEnd("string")
.hourEnd("string")
.logic("string")
.minute("string")
.dayMonth("string")
.month("string")
.hour("string")
.name("string")
.notBefore("string")
.notOnOrAfter("string")
.description("string")
.dayMonthEnd("string")
.year("string")
.yearEnd("string")
.build());
client_time_policy_resource = keycloak.openid.ClientTimePolicy("clientTimePolicyResource",
realm_id="string",
resource_server_id="string",
decision_strategy="string",
minute_end="string",
month_end="string",
hour_end="string",
logic="string",
minute="string",
day_month="string",
month="string",
hour="string",
name="string",
not_before="string",
not_on_or_after="string",
description="string",
day_month_end="string",
year="string",
year_end="string")
const clientTimePolicyResource = new keycloak.openid.ClientTimePolicy("clientTimePolicyResource", {
realmId: "string",
resourceServerId: "string",
decisionStrategy: "string",
minuteEnd: "string",
monthEnd: "string",
hourEnd: "string",
logic: "string",
minute: "string",
dayMonth: "string",
month: "string",
hour: "string",
name: "string",
notBefore: "string",
notOnOrAfter: "string",
description: "string",
dayMonthEnd: "string",
year: "string",
yearEnd: "string",
});
type: keycloak:openid:ClientTimePolicy
properties:
dayMonth: string
dayMonthEnd: string
decisionStrategy: string
description: string
hour: string
hourEnd: string
logic: string
minute: string
minuteEnd: string
month: string
monthEnd: string
name: string
notBefore: string
notOnOrAfter: string
realmId: string
resourceServerId: string
year: string
yearEnd: string
ClientTimePolicy 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 ClientTimePolicy resource accepts the following input properties:
- Decision
Strategy string - Realm
Id string - Resource
Server stringId - Day
Month string - Day
Month stringEnd - Description string
- Hour string
- Hour
End string - Logic string
- Minute string
- Minute
End string - Month string
- Month
End string - Name string
- Not
Before string - Not
On stringOr After - Year string
- Year
End string
- Decision
Strategy string - Realm
Id string - Resource
Server stringId - Day
Month string - Day
Month stringEnd - Description string
- Hour string
- Hour
End string - Logic string
- Minute string
- Minute
End string - Month string
- Month
End string - Name string
- Not
Before string - Not
On stringOr After - Year string
- Year
End string
- decision
Strategy String - realm
Id String - resource
Server StringId - day
Month String - day
Month StringEnd - description String
- hour String
- hour
End String - logic String
- minute String
- minute
End String - month String
- month
End String - name String
- not
Before String - not
On StringOr After - year String
- year
End String
- decision
Strategy string - realm
Id string - resource
Server stringId - day
Month string - day
Month stringEnd - description string
- hour string
- hour
End string - logic string
- minute string
- minute
End string - month string
- month
End string - name string
- not
Before string - not
On stringOr After - year string
- year
End string
- decision_
strategy str - realm_
id str - resource_
server_ strid - day_
month str - day_
month_ strend - description str
- hour str
- hour_
end str - logic str
- minute str
- minute_
end str - month str
- month_
end str - name str
- not_
before str - not_
on_ stror_ after - year str
- year_
end str
- decision
Strategy String - realm
Id String - resource
Server StringId - day
Month String - day
Month StringEnd - description String
- hour String
- hour
End String - logic String
- minute String
- minute
End String - month String
- month
End String - name String
- not
Before String - not
On StringOr After - year String
- year
End String
Outputs
All input properties are implicitly available as output properties. Additionally, the ClientTimePolicy 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 ClientTimePolicy Resource
Get an existing ClientTimePolicy 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?: ClientTimePolicyState, opts?: CustomResourceOptions): ClientTimePolicy@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
day_month: Optional[str] = None,
day_month_end: Optional[str] = None,
decision_strategy: Optional[str] = None,
description: Optional[str] = None,
hour: Optional[str] = None,
hour_end: Optional[str] = None,
logic: Optional[str] = None,
minute: Optional[str] = None,
minute_end: Optional[str] = None,
month: Optional[str] = None,
month_end: Optional[str] = None,
name: Optional[str] = None,
not_before: Optional[str] = None,
not_on_or_after: Optional[str] = None,
realm_id: Optional[str] = None,
resource_server_id: Optional[str] = None,
year: Optional[str] = None,
year_end: Optional[str] = None) -> ClientTimePolicyfunc GetClientTimePolicy(ctx *Context, name string, id IDInput, state *ClientTimePolicyState, opts ...ResourceOption) (*ClientTimePolicy, error)public static ClientTimePolicy Get(string name, Input<string> id, ClientTimePolicyState? state, CustomResourceOptions? opts = null)public static ClientTimePolicy get(String name, Output<String> id, ClientTimePolicyState state, CustomResourceOptions options)Resource lookup is not supported in YAML- 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.
- Day
Month string - Day
Month stringEnd - Decision
Strategy string - Description string
- Hour string
- Hour
End string - Logic string
- Minute string
- Minute
End string - Month string
- Month
End string - Name string
- Not
Before string - Not
On stringOr After - Realm
Id string - Resource
Server stringId - Year string
- Year
End string
- Day
Month string - Day
Month stringEnd - Decision
Strategy string - Description string
- Hour string
- Hour
End string - Logic string
- Minute string
- Minute
End string - Month string
- Month
End string - Name string
- Not
Before string - Not
On stringOr After - Realm
Id string - Resource
Server stringId - Year string
- Year
End string
- day
Month String - day
Month StringEnd - decision
Strategy String - description String
- hour String
- hour
End String - logic String
- minute String
- minute
End String - month String
- month
End String - name String
- not
Before String - not
On StringOr After - realm
Id String - resource
Server StringId - year String
- year
End String
- day
Month string - day
Month stringEnd - decision
Strategy string - description string
- hour string
- hour
End string - logic string
- minute string
- minute
End string - month string
- month
End string - name string
- not
Before string - not
On stringOr After - realm
Id string - resource
Server stringId - year string
- year
End string
- day_
month str - day_
month_ strend - decision_
strategy str - description str
- hour str
- hour_
end str - logic str
- minute str
- minute_
end str - month str
- month_
end str - name str
- not_
before str - not_
on_ stror_ after - realm_
id str - resource_
server_ strid - year str
- year_
end str
- day
Month String - day
Month StringEnd - decision
Strategy String - description String
- hour String
- hour
End String - logic String
- minute String
- minute
End String - month String
- month
End String - name String
- not
Before String - not
On StringOr After - realm
Id String - resource
Server StringId - year String
- year
End String
Package Details
- Repository
- Keycloak pulumi/pulumi-keycloak
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
keycloakTerraform Provider.