1. Docs
  2. Reference
  3. API
  4. Okta
  5. profile
  6. Mapping

Mapping

Create a Mapping Resource

new Mapping(name: string, args: MappingArgs, opts?: CustomResourceOptions);
def Mapping(resource_name, opts=None, delete_when_absent=None, mappings=None, source_id=None, target_id=None, __props__=None);
func NewMapping(ctx *Context, name string, args MappingArgs, opts ...ResourceOption) (*Mapping, error)
public Mapping(string name, MappingArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args MappingArgs
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 MappingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args MappingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Mapping Resource Properties

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

Inputs

The Mapping resource accepts the following input properties:

SourceId string

The source id of the mapping to manage.

TargetId string

The target id of the mapping to manage.

DeleteWhenAbsent bool

When turned on this flag will trigger the provider to delete mapping properties that are not defined in config. By default, we do not delete missing properties.

Mappings List<MappingMappingArgs>
SourceId string

The source id of the mapping to manage.

TargetId string

The target id of the mapping to manage.

DeleteWhenAbsent bool

When turned on this flag will trigger the provider to delete mapping properties that are not defined in config. By default, we do not delete missing properties.

Mappings []MappingMapping
sourceId string

The source id of the mapping to manage.

targetId string

The target id of the mapping to manage.

deleteWhenAbsent boolean

When turned on this flag will trigger the provider to delete mapping properties that are not defined in config. By default, we do not delete missing properties.

mappings MappingMapping[]
source_id str

The source id of the mapping to manage.

target_id str

The target id of the mapping to manage.

delete_when_absent bool

When turned on this flag will trigger the provider to delete mapping properties that are not defined in config. By default, we do not delete missing properties.

mappings List[MappingMapping]

Outputs

All input properties are implicitly available as output properties. Additionally, the Mapping resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
SourceName string
SourceType string
TargetName string
TargetType string
Id string
The provider-assigned unique ID for this managed resource.
SourceName string
SourceType string
TargetName string
TargetType string
id string
The provider-assigned unique ID for this managed resource.
sourceName string
sourceType string
targetName string
targetType string
id str
The provider-assigned unique ID for this managed resource.
source_name str
source_type str
target_name str
target_type str

Look up an Existing Mapping Resource

Get an existing Mapping 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?: MappingState, opts?: CustomResourceOptions): Mapping
static get(resource_name, id, opts=None, delete_when_absent=None, mappings=None, source_id=None, source_name=None, source_type=None, target_id=None, target_name=None, target_type=None, __props__=None);
func GetMapping(ctx *Context, name string, id IDInput, state *MappingState, opts ...ResourceOption) (*Mapping, error)
public static Mapping Get(string name, Input<string> id, MappingState? 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:

DeleteWhenAbsent bool

When turned on this flag will trigger the provider to delete mapping properties that are not defined in config. By default, we do not delete missing properties.

Mappings List<MappingMappingArgs>
SourceId string

The source id of the mapping to manage.

SourceName string
SourceType string
TargetId string

The target id of the mapping to manage.

TargetName string
TargetType string
DeleteWhenAbsent bool

When turned on this flag will trigger the provider to delete mapping properties that are not defined in config. By default, we do not delete missing properties.

Mappings []MappingMapping
SourceId string

The source id of the mapping to manage.

SourceName string
SourceType string
TargetId string

The target id of the mapping to manage.

TargetName string
TargetType string
deleteWhenAbsent boolean

When turned on this flag will trigger the provider to delete mapping properties that are not defined in config. By default, we do not delete missing properties.

mappings MappingMapping[]
sourceId string

The source id of the mapping to manage.

sourceName string
sourceType string
targetId string

The target id of the mapping to manage.

targetName string
targetType string
delete_when_absent bool

When turned on this flag will trigger the provider to delete mapping properties that are not defined in config. By default, we do not delete missing properties.

mappings List[MappingMapping]
source_id str

The source id of the mapping to manage.

source_name str
source_type str
target_id str

The target id of the mapping to manage.

target_name str
target_type str

Supporting Types

MappingMapping

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Expression string
Id string
PushStatus string
Expression string
Id string
PushStatus string
expression string
id string
pushStatus string
expression str
id str
pushStatus str

Package Details

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