1. Docs
  2. Reference
  3. API
  4. Keycloak
  5. authentication
  6. Flow

Flow

Create a Flow Resource

new Flow(name: string, args: FlowArgs, opts?: CustomResourceOptions);
def Flow(resource_name, opts=None, alias=None, description=None, provider_id=None, realm_id=None, __props__=None);
func NewFlow(ctx *Context, name string, args FlowArgs, opts ...ResourceOption) (*Flow, error)
public Flow(string name, FlowArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args FlowArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args FlowArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args FlowArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Flow Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Flow resource accepts the following input properties:

Alias string
RealmId string
Description string
ProviderId string
Alias string
RealmId string
Description string
ProviderId string
alias string
realmId string
description string
providerId string
alias str
realm_id str
description str
provider_id str

Outputs

All input properties are implicitly available as output properties. Additionally, the Flow 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 str
The provider-assigned unique ID for this managed resource.

Look up an Existing Flow Resource

Get an existing Flow 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?: FlowState, opts?: CustomResourceOptions): Flow
static get(resource_name, id, opts=None, alias=None, description=None, provider_id=None, realm_id=None, __props__=None);
func GetFlow(ctx *Context, name string, id IDInput, state *FlowState, opts ...ResourceOption) (*Flow, error)
public static Flow Get(string name, Input<string> id, FlowState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

Alias string
Description string
ProviderId string
RealmId string
Alias string
Description string
ProviderId string
RealmId string
alias string
description string
providerId string
realmId string
alias str
description str
provider_id str
realm_id str

Package Details

Repository
https://github.com/pulumi/pulumi-keycloak
License
Apache-2.0
Notes
This Pulumi package is based on the keycloak Terraform Provider.