« blib/lib/Paws/SageMaker/UserProfileDetails.pm
↑ Summary
blib/lib/Paws/SageMaker/VariantProperty.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SageMaker::UserSettings; | ||
| 3 | use Moose; | ||
| 4 | has ExecutionRole => (is => 'ro', isa => 'Str'); | ||
| 5 | has JupyterServerAppSettings => (is => 'ro', isa => 'Paws::SageMaker::JupyterServerAppSettings'); | ||
| 6 | has KernelGatewayAppSettings => (is => 'ro', isa => 'Paws::SageMaker::KernelGatewayAppSettings'); | ||
| 7 | has SecurityGroups => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 8 | has SharingSettings => (is => 'ro', isa => 'Paws::SageMaker::SharingSettings'); | ||
| 9 | has TensorBoardAppSettings => (is => 'ro', isa => 'Paws::SageMaker::TensorBoardAppSettings'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::SageMaker::UserSettings | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::SageMaker::UserSettings object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { ExecutionRole => $value, ..., TensorBoardAppSettings => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::SageMaker::UserSettings object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->ExecutionRole | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | A collection of settings that apply to users of Amazon SageMaker | ||
| 42 | Studio. These settings are specified when the C<CreateUserProfile> API | ||
| 43 | is called, and as C<DefaultUserSettings> when the C<CreateDomain> API | ||
| 44 | is called. | ||
| 45 | |||
| 46 | C<SecurityGroups> is aggregated when specified in both calls. For all | ||
| 47 | other settings in C<UserSettings>, the values specified in | ||
| 48 | C<CreateUserProfile> take precedence over those specified in | ||
| 49 | C<CreateDomain>. | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 ExecutionRole => Str | ||
| 55 | |||
| 56 | The execution role for the user. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 JupyterServerAppSettings => L<Paws::SageMaker::JupyterServerAppSettings> | ||
| 60 | |||
| 61 | The Jupyter server's app settings. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 KernelGatewayAppSettings => L<Paws::SageMaker::KernelGatewayAppSettings> | ||
| 65 | |||
| 66 | The kernel gateway app settings. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 SecurityGroups => ArrayRef[Str|Undef] | ||
| 70 | |||
| 71 | The security groups for the Amazon Virtual Private Cloud (VPC) that | ||
| 72 | Studio uses for communication. | ||
| 73 | |||
| 74 | Optional when the C<CreateDomain.AppNetworkAccessType> parameter is set | ||
| 75 | to C<PublicInternetOnly>. | ||
| 76 | |||
| 77 | Required when the C<CreateDomain.AppNetworkAccessType> parameter is set | ||
| 78 | to C<VpcOnly>. | ||
| 79 | |||
| 80 | Amazon SageMaker adds a security group to allow NFS traffic from | ||
| 81 | SageMaker Studio. Therefore, the number of security groups that you can | ||
| 82 | specify is one less than the maximum number shown. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 SharingSettings => L<Paws::SageMaker::SharingSettings> | ||
| 86 | |||
| 87 | Specifies options for sharing SageMaker Studio notebooks. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 TensorBoardAppSettings => L<Paws::SageMaker::TensorBoardAppSettings> | ||
| 91 | |||
| 92 | The TensorBoard app settings. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head1 SEE ALSO | ||
| 97 | |||
| 98 | This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker> | ||
| 99 | |||
| 100 | =head1 BUGS and CONTRIBUTIONS | ||
| 101 | |||
| 102 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 103 | |||
| 104 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 105 | |||
| 106 | =cut | ||
| 107 |