AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
aws.opsworks.UserProfile
Explore with Pulumi AI
Provides an OpsWorks User Profile resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const myProfile = new aws.opsworks.UserProfile("my_profile", {
userArn: user.arn,
sshUsername: "my_user",
});
import pulumi
import pulumi_aws as aws
my_profile = aws.opsworks.UserProfile("my_profile",
user_arn=user["arn"],
ssh_username="my_user")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/opsworks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := opsworks.NewUserProfile(ctx, "my_profile", &opsworks.UserProfileArgs{
UserArn: pulumi.Any(user.Arn),
SshUsername: pulumi.String("my_user"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var myProfile = new Aws.OpsWorks.UserProfile("my_profile", new()
{
UserArn = user.Arn,
SshUsername = "my_user",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.opsworks.UserProfile;
import com.pulumi.aws.opsworks.UserProfileArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var myProfile = new UserProfile("myProfile", UserProfileArgs.builder()
.userArn(user.arn())
.sshUsername("my_user")
.build());
}
}
resources:
myProfile:
type: aws:opsworks:UserProfile
name: my_profile
properties:
userArn: ${user.arn}
sshUsername: my_user
Create UserProfile Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new UserProfile(name: string, args: UserProfileArgs, opts?: CustomResourceOptions);
@overload
def UserProfile(resource_name: str,
args: UserProfileArgs,
opts: Optional[ResourceOptions] = None)
@overload
def UserProfile(resource_name: str,
opts: Optional[ResourceOptions] = None,
ssh_username: Optional[str] = None,
user_arn: Optional[str] = None,
allow_self_management: Optional[bool] = None,
ssh_public_key: Optional[str] = None)
func NewUserProfile(ctx *Context, name string, args UserProfileArgs, opts ...ResourceOption) (*UserProfile, error)
public UserProfile(string name, UserProfileArgs args, CustomResourceOptions? opts = null)
public UserProfile(String name, UserProfileArgs args)
public UserProfile(String name, UserProfileArgs args, CustomResourceOptions options)
type: aws:opsworks:UserProfile
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 UserProfileArgs
- 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 UserProfileArgs
- 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 UserProfileArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args UserProfileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args UserProfileArgs
- 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 userProfileResource = new Aws.OpsWorks.UserProfile("userProfileResource", new()
{
SshUsername = "string",
UserArn = "string",
AllowSelfManagement = false,
SshPublicKey = "string",
});
example, err := opsworks.NewUserProfile(ctx, "userProfileResource", &opsworks.UserProfileArgs{
SshUsername: pulumi.String("string"),
UserArn: pulumi.String("string"),
AllowSelfManagement: pulumi.Bool(false),
SshPublicKey: pulumi.String("string"),
})
var userProfileResource = new UserProfile("userProfileResource", UserProfileArgs.builder()
.sshUsername("string")
.userArn("string")
.allowSelfManagement(false)
.sshPublicKey("string")
.build());
user_profile_resource = aws.opsworks.UserProfile("userProfileResource",
ssh_username="string",
user_arn="string",
allow_self_management=False,
ssh_public_key="string")
const userProfileResource = new aws.opsworks.UserProfile("userProfileResource", {
sshUsername: "string",
userArn: "string",
allowSelfManagement: false,
sshPublicKey: "string",
});
type: aws:opsworks:UserProfile
properties:
allowSelfManagement: false
sshPublicKey: string
sshUsername: string
userArn: string
UserProfile Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The UserProfile resource accepts the following input properties:
- Ssh
Username string - The ssh username, with witch this user wants to log in
- User
Arn string - The user's IAM ARN
- Allow
Self boolManagement - Whether users can specify their own SSH public key through the My Settings page
- Ssh
Public stringKey - The users public key
- Ssh
Username string - The ssh username, with witch this user wants to log in
- User
Arn string - The user's IAM ARN
- Allow
Self boolManagement - Whether users can specify their own SSH public key through the My Settings page
- Ssh
Public stringKey - The users public key
- ssh
Username String - The ssh username, with witch this user wants to log in
- user
Arn String - The user's IAM ARN
- allow
Self BooleanManagement - Whether users can specify their own SSH public key through the My Settings page
- ssh
Public StringKey - The users public key
- ssh
Username string - The ssh username, with witch this user wants to log in
- user
Arn string - The user's IAM ARN
- allow
Self booleanManagement - Whether users can specify their own SSH public key through the My Settings page
- ssh
Public stringKey - The users public key
- ssh_
username str - The ssh username, with witch this user wants to log in
- user_
arn str - The user's IAM ARN
- allow_
self_ boolmanagement - Whether users can specify their own SSH public key through the My Settings page
- ssh_
public_ strkey - The users public key
- ssh
Username String - The ssh username, with witch this user wants to log in
- user
Arn String - The user's IAM ARN
- allow
Self BooleanManagement - Whether users can specify their own SSH public key through the My Settings page
- ssh
Public StringKey - The users public key
Outputs
All input properties are implicitly available as output properties. Additionally, the UserProfile 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 UserProfile Resource
Get an existing UserProfile 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?: UserProfileState, opts?: CustomResourceOptions): UserProfile
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
allow_self_management: Optional[bool] = None,
ssh_public_key: Optional[str] = None,
ssh_username: Optional[str] = None,
user_arn: Optional[str] = None) -> UserProfile
func GetUserProfile(ctx *Context, name string, id IDInput, state *UserProfileState, opts ...ResourceOption) (*UserProfile, error)
public static UserProfile Get(string name, Input<string> id, UserProfileState? state, CustomResourceOptions? opts = null)
public static UserProfile get(String name, Output<String> id, UserProfileState 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.
- Allow
Self boolManagement - Whether users can specify their own SSH public key through the My Settings page
- Ssh
Public stringKey - The users public key
- Ssh
Username string - The ssh username, with witch this user wants to log in
- User
Arn string - The user's IAM ARN
- Allow
Self boolManagement - Whether users can specify their own SSH public key through the My Settings page
- Ssh
Public stringKey - The users public key
- Ssh
Username string - The ssh username, with witch this user wants to log in
- User
Arn string - The user's IAM ARN
- allow
Self BooleanManagement - Whether users can specify their own SSH public key through the My Settings page
- ssh
Public StringKey - The users public key
- ssh
Username String - The ssh username, with witch this user wants to log in
- user
Arn String - The user's IAM ARN
- allow
Self booleanManagement - Whether users can specify their own SSH public key through the My Settings page
- ssh
Public stringKey - The users public key
- ssh
Username string - The ssh username, with witch this user wants to log in
- user
Arn string - The user's IAM ARN
- allow_
self_ boolmanagement - Whether users can specify their own SSH public key through the My Settings page
- ssh_
public_ strkey - The users public key
- ssh_
username str - The ssh username, with witch this user wants to log in
- user_
arn str - The user's IAM ARN
- allow
Self BooleanManagement - Whether users can specify their own SSH public key through the My Settings page
- ssh
Public StringKey - The users public key
- ssh
Username String - The ssh username, with witch this user wants to log in
- user
Arn String - The user's IAM ARN
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.