Documentation
¶
Index ¶
- type GetAuthScopeArgs
- type GetAuthScopeResult
- type GetEndpointArgs
- type GetEndpointResult
- type GetGroupArgs
- type GetGroupResult
- type GetProjectArgs
- type GetProjectResult
- type GetRoleArgs
- type GetRoleResult
- type GetUserArgs
- type GetUserResult
- type Project
- func (r *Project) Description() *pulumi.StringOutput
- func (r *Project) DomainId() *pulumi.StringOutput
- func (r *Project) Enabled() *pulumi.BoolOutput
- func (r *Project) ID() *pulumi.IDOutput
- func (r *Project) IsDomain() *pulumi.BoolOutput
- func (r *Project) Name() *pulumi.StringOutput
- func (r *Project) ParentId() *pulumi.StringOutput
- func (r *Project) Region() *pulumi.StringOutput
- func (r *Project) URN() *pulumi.URNOutput
- type ProjectArgs
- type ProjectState
- type Role
- type RoleArgs
- type RoleAssignment
- func (r *RoleAssignment) DomainId() *pulumi.StringOutput
- func (r *RoleAssignment) GroupId() *pulumi.StringOutput
- func (r *RoleAssignment) ID() *pulumi.IDOutput
- func (r *RoleAssignment) ProjectId() *pulumi.StringOutput
- func (r *RoleAssignment) Region() *pulumi.StringOutput
- func (r *RoleAssignment) RoleId() *pulumi.StringOutput
- func (r *RoleAssignment) URN() *pulumi.URNOutput
- func (r *RoleAssignment) UserId() *pulumi.StringOutput
- type RoleAssignmentArgs
- type RoleAssignmentState
- type RoleState
- type User
- func (r *User) DefaultProjectId() *pulumi.StringOutput
- func (r *User) Description() *pulumi.StringOutput
- func (r *User) DomainId() *pulumi.StringOutput
- func (r *User) Enabled() *pulumi.BoolOutput
- func (r *User) Extra() *pulumi.MapOutput
- func (r *User) ID() *pulumi.IDOutput
- func (r *User) IgnoreChangePasswordUponFirstUse() *pulumi.BoolOutput
- func (r *User) IgnoreLockoutFailureAttempts() *pulumi.BoolOutput
- func (r *User) IgnorePasswordExpiry() *pulumi.BoolOutput
- func (r *User) MultiFactorAuthEnabled() *pulumi.BoolOutput
- func (r *User) MultiFactorAuthRules() *pulumi.ArrayOutput
- func (r *User) Name() *pulumi.StringOutput
- func (r *User) Password() *pulumi.StringOutput
- func (r *User) Region() *pulumi.StringOutput
- func (r *User) URN() *pulumi.URNOutput
- type UserArgs
- type UserState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GetAuthScopeArgs ¶
type GetAuthScopeArgs struct { // The name of the scope. This is an arbitrary name which is // only used as a unique identifier so an actual token isn't used as the ID. Name interface{} // The region in which to obtain the V3 Identity client. // A Identity client is needed to retrieve tokens IDs. If omitted, the // `region` argument of the provider is used. Region interface{} }
A collection of arguments for invoking getAuthScope.
type GetAuthScopeResult ¶
type GetAuthScopeResult struct { // The domain ID of the project. ProjectDomainId interface{} // The domain name of the project. ProjectDomainName interface{} // The project ID of the scope. ProjectId interface{} // The project name of the scope. ProjectName interface{} Region interface{} // A list of roles in the current scope. See reference below. Roles interface{} // The domain ID of the user. UserDomainId interface{} // The domain name of the user. UserDomainName interface{} // The user ID the of the scope. UserId interface{} // The username of the scope. UserName interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getAuthScope.
func LookupAuthScope ¶
func LookupAuthScope(ctx *pulumi.Context, args *GetAuthScopeArgs) (*GetAuthScopeResult, error)
Use this data source to get authentication information about the current auth scope in use. This can be used as self-discovery or introspection of the username or project name currently in use.
type GetEndpointArgs ¶ added in v0.15.0
type GetEndpointArgs struct { // The endpoint interface. Valid values are `public`, // `internal`, and `admin`. Default value is `public` Interface interface{} // The region the endpoint is located in. Region interface{} // The service id this endpoint belongs to. ServiceId interface{} // The service name of the endpoint. ServiceName interface{} }
A collection of arguments for invoking getEndpoint.
type GetEndpointResult ¶ added in v0.15.0
type GetEndpointResult struct { // The region the endpoint is located in. Region interface{} // The endpoint URL Url interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getEndpoint.
func LookupEndpoint ¶ added in v0.15.0
func LookupEndpoint(ctx *pulumi.Context, args *GetEndpointArgs) (*GetEndpointResult, error)
Use this data source to get the ID of an OpenStack endpoint.
Note: This usually requires admin privileges.
type GetGroupArgs ¶ added in v0.15.0
type GetGroupArgs struct { // The domain the group belongs to. DomainId interface{} // The name of the group. Name interface{} // The region in which to obtain the V3 Keystone client. // If omitted, the `region` argument of the provider is used. Region interface{} }
A collection of arguments for invoking getGroup.
type GetGroupResult ¶ added in v0.15.0
type GetGroupResult struct { // See Argument Reference above. DomainId interface{} // See Argument Reference above. Region interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getGroup.
func LookupGroup ¶ added in v0.15.0
func LookupGroup(ctx *pulumi.Context, args *GetGroupArgs) (*GetGroupResult, error)
Use this data source to get the ID of an OpenStack group.
Note: This usually requires admin privileges.
type GetProjectArgs ¶
type GetProjectArgs struct { // The domain this project belongs to. DomainId interface{} // Whether the project is enabled or disabled. Valid // values are `true` and `false`. Enabled interface{} // Whether this project is a domain. Valid values // are `true` and `false`. IsDomain interface{} // The name of the project. Name interface{} // The parent of this project. ParentId interface{} Region interface{} }
A collection of arguments for invoking getProject.
type GetProjectResult ¶
type GetProjectResult struct { // The description of the project. Description interface{} // See Argument Reference above. DomainId interface{} // The region the project is located in. Region interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getProject.
func LookupProject ¶
func LookupProject(ctx *pulumi.Context, args *GetProjectArgs) (*GetProjectResult, error)
Use this data source to get the ID of an OpenStack project.
type GetRoleArgs ¶
type GetRoleArgs struct { // The domain the role belongs to. DomainId interface{} // The name of the role. Name interface{} // The region in which to obtain the V3 Keystone client. // If omitted, the `region` argument of the provider is used. Region interface{} }
A collection of arguments for invoking getRole.
type GetRoleResult ¶
type GetRoleResult struct { // See Argument Reference above. DomainId interface{} // See Argument Reference above. Region interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getRole.
func LookupRole ¶
func LookupRole(ctx *pulumi.Context, args *GetRoleArgs) (*GetRoleResult, error)
Use this data source to get the ID of an OpenStack role.
type GetUserArgs ¶
type GetUserArgs struct { // The domain this user belongs to. DomainId interface{} // Whether the user is enabled or disabled. Valid // values are `true` and `false`. Enabled interface{} // The identity provider ID of the user. IdpId interface{} // The name of the user. Name interface{} // Query for expired passwords. See the [OpenStack API docs](https://developer.openstack.org/api-ref/identity/v3/#list-users) for more information on the query format. PasswordExpiresAt interface{} // The protocol ID of the user. ProtocolId interface{} Region interface{} // The unique ID of the user. UniqueId interface{} }
A collection of arguments for invoking getUser.
type GetUserResult ¶
type GetUserResult struct { // See Argument Reference above. DefaultProjectId interface{} // See Argument Reference above. DomainId interface{} // The region the user is located in. Region interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getUser.
func LookupUser ¶
func LookupUser(ctx *pulumi.Context, args *GetUserArgs) (*GetUserResult, error)
Use this data source to get the ID of an OpenStack user.
type Project ¶
type Project struct {
// contains filtered or unexported fields
}
Manages a V3 Project resource within OpenStack Keystone.
Note: You _must_ have admin privileges in your OpenStack cloud to use this resource.
func GetProject ¶
func GetProject(ctx *pulumi.Context, name string, id pulumi.ID, state *ProjectState, opts ...pulumi.ResourceOpt) (*Project, error)
GetProject gets an existing Project resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewProject ¶
func NewProject(ctx *pulumi.Context, name string, args *ProjectArgs, opts ...pulumi.ResourceOpt) (*Project, error)
NewProject registers a new resource with the given unique name, arguments, and options.
func (*Project) Description ¶
func (r *Project) Description() *pulumi.StringOutput
A description of the project.
func (*Project) DomainId ¶
func (r *Project) DomainId() *pulumi.StringOutput
The domain this project belongs to.
func (*Project) Enabled ¶
func (r *Project) Enabled() *pulumi.BoolOutput
Whether the project is enabled or disabled. Valid values are `true` and `false`.
func (*Project) IsDomain ¶
func (r *Project) IsDomain() *pulumi.BoolOutput
Whether this project is a domain. Valid values are `true` and `false`.
func (*Project) ParentId ¶
func (r *Project) ParentId() *pulumi.StringOutput
The parent of this project.
func (*Project) Region ¶
func (r *Project) Region() *pulumi.StringOutput
The region in which to obtain the V3 Keystone client. If omitted, the `region` argument of the provider is used. Changing this creates a new User.
type ProjectArgs ¶
type ProjectArgs struct { // A description of the project. Description interface{} // The domain this project belongs to. DomainId interface{} // Whether the project is enabled or disabled. Valid // values are `true` and `false`. Enabled interface{} // Whether this project is a domain. Valid values // are `true` and `false`. IsDomain interface{} // The name of the project. Name interface{} // The parent of this project. ParentId interface{} // The region in which to obtain the V3 Keystone client. // If omitted, the `region` argument of the provider is used. Changing this // creates a new User. Region interface{} }
The set of arguments for constructing a Project resource.
type ProjectState ¶
type ProjectState struct { // A description of the project. Description interface{} // The domain this project belongs to. DomainId interface{} // Whether the project is enabled or disabled. Valid // values are `true` and `false`. Enabled interface{} // Whether this project is a domain. Valid values // are `true` and `false`. IsDomain interface{} // The name of the project. Name interface{} // The parent of this project. ParentId interface{} // The region in which to obtain the V3 Keystone client. // If omitted, the `region` argument of the provider is used. Changing this // creates a new User. Region interface{} }
Input properties used for looking up and filtering Project resources.
type Role ¶
type Role struct {
// contains filtered or unexported fields
}
Manages a V3 Role resource within OpenStack Keystone.
Note: You _must_ have admin privileges in your OpenStack cloud to use this resource.
func GetRole ¶
func GetRole(ctx *pulumi.Context, name string, id pulumi.ID, state *RoleState, opts ...pulumi.ResourceOpt) (*Role, error)
GetRole gets an existing Role resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewRole ¶
func NewRole(ctx *pulumi.Context, name string, args *RoleArgs, opts ...pulumi.ResourceOpt) (*Role, error)
NewRole registers a new resource with the given unique name, arguments, and options.
func (*Role) DomainId ¶
func (r *Role) DomainId() *pulumi.StringOutput
The domain the role belongs to.
func (*Role) Region ¶
func (r *Role) Region() *pulumi.StringOutput
The region in which to obtain the V3 Keystone client. If omitted, the `region` argument of the provider is used. Changing this creates a new Role.
type RoleArgs ¶
type RoleArgs struct { // The domain the role belongs to. DomainId interface{} // The name of the role. Name interface{} // The region in which to obtain the V3 Keystone client. // If omitted, the `region` argument of the provider is used. Changing this // creates a new Role. Region interface{} }
The set of arguments for constructing a Role resource.
type RoleAssignment ¶
type RoleAssignment struct {
// contains filtered or unexported fields
}
Manages a V3 Role assignment within OpenStack Keystone.
Note: You _must_ have admin privileges in your OpenStack cloud to use this resource.
func GetRoleAssignment ¶
func GetRoleAssignment(ctx *pulumi.Context, name string, id pulumi.ID, state *RoleAssignmentState, opts ...pulumi.ResourceOpt) (*RoleAssignment, error)
GetRoleAssignment gets an existing RoleAssignment resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewRoleAssignment ¶
func NewRoleAssignment(ctx *pulumi.Context, name string, args *RoleAssignmentArgs, opts ...pulumi.ResourceOpt) (*RoleAssignment, error)
NewRoleAssignment registers a new resource with the given unique name, arguments, and options.
func (*RoleAssignment) DomainId ¶
func (r *RoleAssignment) DomainId() *pulumi.StringOutput
The domain to assign the role in.
func (*RoleAssignment) GroupId ¶
func (r *RoleAssignment) GroupId() *pulumi.StringOutput
The group to assign the role to.
func (*RoleAssignment) ID ¶
func (r *RoleAssignment) ID() *pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*RoleAssignment) ProjectId ¶
func (r *RoleAssignment) ProjectId() *pulumi.StringOutput
The project to assign the role in.
func (*RoleAssignment) Region ¶ added in v0.16.5
func (r *RoleAssignment) Region() *pulumi.StringOutput
func (*RoleAssignment) RoleId ¶
func (r *RoleAssignment) RoleId() *pulumi.StringOutput
The role to assign.
func (*RoleAssignment) URN ¶
func (r *RoleAssignment) URN() *pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
func (*RoleAssignment) UserId ¶
func (r *RoleAssignment) UserId() *pulumi.StringOutput
The user to assign the role to.
type RoleAssignmentArgs ¶
type RoleAssignmentArgs struct { // The domain to assign the role in. DomainId interface{} // The group to assign the role to. GroupId interface{} // The project to assign the role in. ProjectId interface{} Region interface{} // The role to assign. RoleId interface{} // The user to assign the role to. UserId interface{} }
The set of arguments for constructing a RoleAssignment resource.
type RoleAssignmentState ¶
type RoleAssignmentState struct { // The domain to assign the role in. DomainId interface{} // The group to assign the role to. GroupId interface{} // The project to assign the role in. ProjectId interface{} Region interface{} // The role to assign. RoleId interface{} // The user to assign the role to. UserId interface{} }
Input properties used for looking up and filtering RoleAssignment resources.
type RoleState ¶
type RoleState struct { // The domain the role belongs to. DomainId interface{} // The name of the role. Name interface{} // The region in which to obtain the V3 Keystone client. // If omitted, the `region` argument of the provider is used. Changing this // creates a new Role. Region interface{} }
Input properties used for looking up and filtering Role resources.
type User ¶
type User struct {
// contains filtered or unexported fields
}
Manages a V3 User resource within OpenStack Keystone.
Note: You _must_ have admin privileges in your OpenStack cloud to use this resource.
func GetUser ¶
func GetUser(ctx *pulumi.Context, name string, id pulumi.ID, state *UserState, opts ...pulumi.ResourceOpt) (*User, error)
GetUser gets an existing User resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewUser ¶
func NewUser(ctx *pulumi.Context, name string, args *UserArgs, opts ...pulumi.ResourceOpt) (*User, error)
NewUser registers a new resource with the given unique name, arguments, and options.
func (*User) DefaultProjectId ¶
func (r *User) DefaultProjectId() *pulumi.StringOutput
The default project this user belongs to.
func (*User) Description ¶
func (r *User) Description() *pulumi.StringOutput
A description of the user.
func (*User) DomainId ¶
func (r *User) DomainId() *pulumi.StringOutput
The domain this user belongs to.
func (*User) Enabled ¶
func (r *User) Enabled() *pulumi.BoolOutput
Whether the user is enabled or disabled. Valid values are `true` and `false`.
func (*User) IgnoreChangePasswordUponFirstUse ¶
func (r *User) IgnoreChangePasswordUponFirstUse() *pulumi.BoolOutput
User will not have to change their password upon first use. Valid values are `true` and `false`.
func (*User) IgnoreLockoutFailureAttempts ¶
func (r *User) IgnoreLockoutFailureAttempts() *pulumi.BoolOutput
User will not have a failure lockout placed on their account. Valid values are `true` and `false`.
func (*User) IgnorePasswordExpiry ¶
func (r *User) IgnorePasswordExpiry() *pulumi.BoolOutput
User's password will not expire. Valid values are `true` and `false`.
func (*User) MultiFactorAuthEnabled ¶
func (r *User) MultiFactorAuthEnabled() *pulumi.BoolOutput
Whether to enable multi-factor authentication. Valid values are `true` and `false`.
func (*User) MultiFactorAuthRules ¶
func (r *User) MultiFactorAuthRules() *pulumi.ArrayOutput
A multi-factor authentication rule. The structure is documented below. Please see the [Ocata release notes](https://docs.openstack.org/releasenotes/keystone/ocata.html) for more information on how to use mulit-factor rules.
func (*User) Region ¶
func (r *User) Region() *pulumi.StringOutput
The region in which to obtain the V3 Keystone client. If omitted, the `region` argument of the provider is used. Changing this creates a new User.
type UserArgs ¶
type UserArgs struct { // The default project this user belongs to. DefaultProjectId interface{} // A description of the user. Description interface{} // The domain this user belongs to. DomainId interface{} // Whether the user is enabled or disabled. Valid // values are `true` and `false`. Enabled interface{} // Free-form key/value pairs of extra information. Extra interface{} // User will not have to // change their password upon first use. Valid values are `true` and `false`. IgnoreChangePasswordUponFirstUse interface{} // User will not have a failure // lockout placed on their account. Valid values are `true` and `false`. IgnoreLockoutFailureAttempts interface{} // User's password will not expire. // Valid values are `true` and `false`. IgnorePasswordExpiry interface{} // Whether to enable multi-factor // authentication. Valid values are `true` and `false`. MultiFactorAuthEnabled interface{} // A multi-factor authentication rule. // The structure is documented below. Please see the // [Ocata release notes](https://docs.openstack.org/releasenotes/keystone/ocata.html) // for more information on how to use mulit-factor rules. MultiFactorAuthRules interface{} // The name of the user. Name interface{} // The password for the user. Password interface{} // The region in which to obtain the V3 Keystone client. // If omitted, the `region` argument of the provider is used. Changing this // creates a new User. Region interface{} }
The set of arguments for constructing a User resource.
type UserState ¶
type UserState struct { // The default project this user belongs to. DefaultProjectId interface{} // A description of the user. Description interface{} // The domain this user belongs to. DomainId interface{} // Whether the user is enabled or disabled. Valid // values are `true` and `false`. Enabled interface{} // Free-form key/value pairs of extra information. Extra interface{} // User will not have to // change their password upon first use. Valid values are `true` and `false`. IgnoreChangePasswordUponFirstUse interface{} // User will not have a failure // lockout placed on their account. Valid values are `true` and `false`. IgnoreLockoutFailureAttempts interface{} // User's password will not expire. // Valid values are `true` and `false`. IgnorePasswordExpiry interface{} // Whether to enable multi-factor // authentication. Valid values are `true` and `false`. MultiFactorAuthEnabled interface{} // A multi-factor authentication rule. // The structure is documented below. Please see the // [Ocata release notes](https://docs.openstack.org/releasenotes/keystone/ocata.html) // for more information on how to use mulit-factor rules. MultiFactorAuthRules interface{} // The name of the user. Name interface{} // The password for the user. Password interface{} // The region in which to obtain the V3 Keystone client. // If omitted, the `region` argument of the provider is used. Changing this // creates a new User. Region interface{} }
Input properties used for looking up and filtering User resources.