admin

package
v0.58.7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 11, 2022 License: Apache-2.0 Imports: 20 Imported by: 1

Documentation

Overview

Package admin is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source
var Admin_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "blueapi.admin.v1.Admin",
	HandlerType: (*AdminServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetAccountGroup",
			Handler:    _Admin_GetAccountGroup_Handler,
		},
		{
			MethodName: "GetDefaultCostAccessTemplateUrl",
			Handler:    _Admin_GetDefaultCostAccessTemplateUrl_Handler,
		},
		{
			MethodName: "GetDefaultCostAccess",
			Handler:    _Admin_GetDefaultCostAccess_Handler,
		},
		{
			MethodName: "CreateDefaultCostAccess",
			Handler:    _Admin_CreateDefaultCostAccess_Handler,
		},
		{
			MethodName: "UpdateDefaultCostAccess",
			Handler:    _Admin_UpdateDefaultCostAccess_Handler,
		},
		{
			MethodName: "DeleteDefaultCostAccess",
			Handler:    _Admin_DeleteDefaultCostAccess_Handler,
		},
		{
			MethodName: "GetNotificationSettings",
			Handler:    _Admin_GetNotificationSettings_Handler,
		},
		{
			MethodName: "SaveNotificationSettings",
			Handler:    _Admin_SaveNotificationSettings_Handler,
		},
		{
			MethodName: "ListNotificationChannels",
			Handler:    _Admin_ListNotificationChannels_Handler,
		},
		{
			MethodName: "GetNotificationChannel",
			Handler:    _Admin_GetNotificationChannel_Handler,
		},
		{
			MethodName: "CreateNotificationChannel",
			Handler:    _Admin_CreateNotificationChannel_Handler,
		},
		{
			MethodName: "UpdateNotificationChannel",
			Handler:    _Admin_UpdateNotificationChannel_Handler,
		},
		{
			MethodName: "DeleteNotificationChannel",
			Handler:    _Admin_DeleteNotificationChannel_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "ListAccountGroups",
			Handler:       _Admin_ListAccountGroups_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "ListDefaultCostAccess",
			Handler:       _Admin_ListDefaultCostAccess_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "admin/v1/admin.proto",
}

Admin_ServiceDesc is the grpc.ServiceDesc for Admin service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var File_admin_v1_admin_proto protoreflect.FileDescriptor

Functions

func RegisterAdminHandler

func RegisterAdminHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterAdminHandler registers the http handlers for service Admin to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterAdminHandlerClient

func RegisterAdminHandlerClient(ctx context.Context, mux *runtime.ServeMux, client AdminClient) error

RegisterAdminHandlerClient registers the http handlers for service Admin to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "AdminClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "AdminClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "AdminClient" to call the correct interceptors.

func RegisterAdminHandlerFromEndpoint

func RegisterAdminHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterAdminHandlerFromEndpoint is same as RegisterAdminHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterAdminHandlerServer

func RegisterAdminHandlerServer(ctx context.Context, mux *runtime.ServeMux, server AdminServer) error

RegisterAdminHandlerServer registers the http handlers for service Admin to "mux". UnaryRPC :call AdminServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterAdminHandlerFromEndpoint instead.

func RegisterAdminServer

func RegisterAdminServer(s grpc.ServiceRegistrar, srv AdminServer)

Types

type AdminClient

type AdminClient interface {
	// Lists all account groups.
	ListAccountGroups(ctx context.Context, in *ListAccountGroupsRequest, opts ...grpc.CallOption) (Admin_ListAccountGroupsClient, error)
	// Gets an account group.
	GetAccountGroup(ctx context.Context, in *GetAccountGroupRequest, opts ...grpc.CallOption) (*GetAccountGroupResponse, error)
	// Gets a CloudFormation launch URL for enabling the default cross-account access to your account's cost information based on type.
	// See comments on the type for more information on what each template does.
	GetDefaultCostAccessTemplateUrl(ctx context.Context, in *GetDefaultCostAccessTemplateUrlRequest, opts ...grpc.CallOption) (*GetDefaultCostAccessTemplateUrlResponse, error)
	// Lists the default cross-account access role(s) attached to accounts under caller.
	ListDefaultCostAccess(ctx context.Context, in *ListDefaultCostAccessRequest, opts ...grpc.CallOption) (Admin_ListDefaultCostAccessClient, error)
	// Gets the current default cross-account role attached to the input target.
	GetDefaultCostAccess(ctx context.Context, in *GetDefaultCostAccessRequest, opts ...grpc.CallOption) (*DefaultCostAccess, error)
	// Starts validation of a default cross-account access stack deployment. If successful, the
	// IAM role created from the CloudFormation stack will be registered to the target.
	CreateDefaultCostAccess(ctx context.Context, in *CreateDefaultCostAccessRequest, opts ...grpc.CallOption) (*DefaultCostAccess, error)
	// Starts an update to an existing default cross-account access CloudFormation stack for template changes, if any.
	// Only call this API if the status of your default cross-account access is 'outdated'.
	UpdateDefaultCostAccess(ctx context.Context, in *UpdateDefaultCostAccessRequest, opts ...grpc.CallOption) (*api.Operation, error)
	// Deletes the current default cross-account access role attached to this target account.
	// This does not delete the CloudFormation deployment in your account.
	DeleteDefaultCostAccess(ctx context.Context, in *DeleteDefaultCostAccessRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// WORK-IN-PROGRESS: Get notification settings for login user's organization or group.
	GetNotificationSettings(ctx context.Context, in *GetNotificationSettingsRequest, opts ...grpc.CallOption) (*api.NotificationSettings, error)
	// WORK-IN-PROGRESS: Creates or updates notification settings for login user's organization or group.
	SaveNotificationSettings(ctx context.Context, in *SaveNotificationSettingsRequest, opts ...grpc.CallOption) (*api.NotificationSettings, error)
	// WORK-IN-PROGRESS: Lists all notification channels for login user's organization or group.
	ListNotificationChannels(ctx context.Context, in *ListNotificationChannelsRequest, opts ...grpc.CallOption) (*ListNotificationChannelsResponse, error)
	// WORK-IN-PROGRESS: Gets notification channel for login user's organization or group.
	GetNotificationChannel(ctx context.Context, in *GetNotificationChannelRequest, opts ...grpc.CallOption) (*api.NotificationChannel, error)
	// WORK-IN-PROGRESS: Creates notification settings for login user's organization or group.
	CreateNotificationChannel(ctx context.Context, in *CreateNotificationChannelRequest, opts ...grpc.CallOption) (*api.NotificationChannel, error)
	// WORK-IN-PROGRESS: Updates notification settings for login user's organization or group.
	UpdateNotificationChannel(ctx context.Context, in *UpdateNotificationChannelRequest, opts ...grpc.CallOption) (*api.NotificationChannel, error)
	// WORK-IN-PROGRESS: Deletes notification settings for login user's organization or group.
	DeleteNotificationChannel(ctx context.Context, in *DeleteNotificationChannelRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

AdminClient is the client API for Admin service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewAdminClient

func NewAdminClient(cc grpc.ClientConnInterface) AdminClient

type AdminServer

type AdminServer interface {
	// Lists all account groups.
	ListAccountGroups(*ListAccountGroupsRequest, Admin_ListAccountGroupsServer) error
	// Gets an account group.
	GetAccountGroup(context.Context, *GetAccountGroupRequest) (*GetAccountGroupResponse, error)
	// Gets a CloudFormation launch URL for enabling the default cross-account access to your account's cost information based on type.
	// See comments on the type for more information on what each template does.
	GetDefaultCostAccessTemplateUrl(context.Context, *GetDefaultCostAccessTemplateUrlRequest) (*GetDefaultCostAccessTemplateUrlResponse, error)
	// Lists the default cross-account access role(s) attached to accounts under caller.
	ListDefaultCostAccess(*ListDefaultCostAccessRequest, Admin_ListDefaultCostAccessServer) error
	// Gets the current default cross-account role attached to the input target.
	GetDefaultCostAccess(context.Context, *GetDefaultCostAccessRequest) (*DefaultCostAccess, error)
	// Starts validation of a default cross-account access stack deployment. If successful, the
	// IAM role created from the CloudFormation stack will be registered to the target.
	CreateDefaultCostAccess(context.Context, *CreateDefaultCostAccessRequest) (*DefaultCostAccess, error)
	// Starts an update to an existing default cross-account access CloudFormation stack for template changes, if any.
	// Only call this API if the status of your default cross-account access is 'outdated'.
	UpdateDefaultCostAccess(context.Context, *UpdateDefaultCostAccessRequest) (*api.Operation, error)
	// Deletes the current default cross-account access role attached to this target account.
	// This does not delete the CloudFormation deployment in your account.
	DeleteDefaultCostAccess(context.Context, *DeleteDefaultCostAccessRequest) (*emptypb.Empty, error)
	// WORK-IN-PROGRESS: Get notification settings for login user's organization or group.
	GetNotificationSettings(context.Context, *GetNotificationSettingsRequest) (*api.NotificationSettings, error)
	// WORK-IN-PROGRESS: Creates or updates notification settings for login user's organization or group.
	SaveNotificationSettings(context.Context, *SaveNotificationSettingsRequest) (*api.NotificationSettings, error)
	// WORK-IN-PROGRESS: Lists all notification channels for login user's organization or group.
	ListNotificationChannels(context.Context, *ListNotificationChannelsRequest) (*ListNotificationChannelsResponse, error)
	// WORK-IN-PROGRESS: Gets notification channel for login user's organization or group.
	GetNotificationChannel(context.Context, *GetNotificationChannelRequest) (*api.NotificationChannel, error)
	// WORK-IN-PROGRESS: Creates notification settings for login user's organization or group.
	CreateNotificationChannel(context.Context, *CreateNotificationChannelRequest) (*api.NotificationChannel, error)
	// WORK-IN-PROGRESS: Updates notification settings for login user's organization or group.
	UpdateNotificationChannel(context.Context, *UpdateNotificationChannelRequest) (*api.NotificationChannel, error)
	// WORK-IN-PROGRESS: Deletes notification settings for login user's organization or group.
	DeleteNotificationChannel(context.Context, *DeleteNotificationChannelRequest) (*emptypb.Empty, error)
	// contains filtered or unexported methods
}

AdminServer is the server API for Admin service. All implementations must embed UnimplementedAdminServer for forward compatibility

type Admin_ListAccountGroupsClient

type Admin_ListAccountGroupsClient interface {
	Recv() (*ListAccountGroupsResponse, error)
	grpc.ClientStream
}

type Admin_ListAccountGroupsServer

type Admin_ListAccountGroupsServer interface {
	Send(*ListAccountGroupsResponse) error
	grpc.ServerStream
}

type Admin_ListDefaultCostAccessClient added in v0.57.5

type Admin_ListDefaultCostAccessClient interface {
	Recv() (*DefaultCostAccess, error)
	grpc.ClientStream
}

type Admin_ListDefaultCostAccessServer added in v0.57.5

type Admin_ListDefaultCostAccessServer interface {
	Send(*DefaultCostAccess) error
	grpc.ServerStream
}

type ClientOptions

type ClientOptions struct {
	Conn *conn.GrpcClientConn
}

ClientOptions represents the optional options to NewClient.

type CreateDefaultCostAccessRequest added in v0.57.5

type CreateDefaultCostAccessRequest struct {

	// Required. The target AWS account to validate.
	Target string `protobuf:"bytes,1,opt,name=target,proto3" json:"target,omitempty"`
	// contains filtered or unexported fields
}

Request message for the Admin.CreateDefaultCostAccess rpc.

func (*CreateDefaultCostAccessRequest) Descriptor deprecated added in v0.57.5

func (*CreateDefaultCostAccessRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateDefaultCostAccessRequest.ProtoReflect.Descriptor instead.

func (*CreateDefaultCostAccessRequest) GetTarget added in v0.57.5

func (x *CreateDefaultCostAccessRequest) GetTarget() string

func (*CreateDefaultCostAccessRequest) ProtoMessage added in v0.57.5

func (*CreateDefaultCostAccessRequest) ProtoMessage()

func (*CreateDefaultCostAccessRequest) ProtoReflect added in v0.57.5

func (*CreateDefaultCostAccessRequest) Reset added in v0.57.5

func (x *CreateDefaultCostAccessRequest) Reset()

func (*CreateDefaultCostAccessRequest) String added in v0.57.5

type CreateNotificationChannelRequest added in v0.56.1

type CreateNotificationChannelRequest struct {

	// Required. Name of Notification Channel
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required.
	// Valid values: "email", "slack", "msteams"
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// Required if type="email"
	Email *api.EmailChannel `protobuf:"bytes,3,opt,name=email,proto3" json:"email,omitempty"`
	// Required if type="slack"
	Slack *api.SlackChannel `protobuf:"bytes,4,opt,name=slack,proto3" json:"slack,omitempty"`
	// Required if type="msteams"
	Msteams *api.MSTeamsChannel `protobuf:"bytes,5,opt,name=msteams,proto3" json:"msteams,omitempty"`
	// contains filtered or unexported fields
}

Request message for Admin.CreateNotificationChannel rpc

func (*CreateNotificationChannelRequest) Descriptor deprecated added in v0.56.1

func (*CreateNotificationChannelRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateNotificationChannelRequest.ProtoReflect.Descriptor instead.

func (*CreateNotificationChannelRequest) GetEmail added in v0.56.1

func (*CreateNotificationChannelRequest) GetMsteams added in v0.56.1

func (*CreateNotificationChannelRequest) GetName added in v0.56.1

func (*CreateNotificationChannelRequest) GetSlack added in v0.56.1

func (*CreateNotificationChannelRequest) GetType added in v0.56.1

func (*CreateNotificationChannelRequest) ProtoMessage added in v0.56.1

func (*CreateNotificationChannelRequest) ProtoMessage()

func (*CreateNotificationChannelRequest) ProtoReflect added in v0.56.1

func (*CreateNotificationChannelRequest) Reset added in v0.56.1

func (*CreateNotificationChannelRequest) String added in v0.56.1

type DefaultCostAccess added in v0.57.5

type DefaultCostAccess struct {

	// The queried target account.
	Target string `protobuf:"bytes,1,opt,name=target,proto3" json:"target,omitempty"`
	// The role ARN that provides the cross-account access permissions.
	RoleArn string `protobuf:"bytes,2,opt,name=roleArn,proto3" json:"roleArn,omitempty"`
	// The id of the CloudFormation stack deployed in the target account.
	StackId string `protobuf:"bytes,3,opt,name=stackId,proto3" json:"stackId,omitempty"`
	// The region where the stack is deployed.
	StackRegion string `protobuf:"bytes,4,opt,name=stackRegion,proto3" json:"stackRegion,omitempty"`
	// The latest template used to deploy the stack.
	TemplateUrl string `protobuf:"bytes,5,opt,name=templateUrl,proto3" json:"templateUrl,omitempty"`
	// This can be `latest`, `outdated`, or some error information.
	Status string `protobuf:"bytes,6,opt,name=status,proto3" json:"status,omitempty"`
	// The last updated timestamp, RFC3339 UTC.
	LastUpdated string `protobuf:"bytes,7,opt,name=lastUpdated,proto3" json:"lastUpdated,omitempty"`
	// contains filtered or unexported fields
}

Response message for the Admin.GetDefaultCostAccess, Admin.CreateDefaultCostAccess rpc.

func (*DefaultCostAccess) Descriptor deprecated added in v0.57.5

func (*DefaultCostAccess) Descriptor() ([]byte, []int)

Deprecated: Use DefaultCostAccess.ProtoReflect.Descriptor instead.

func (*DefaultCostAccess) GetLastUpdated added in v0.57.5

func (x *DefaultCostAccess) GetLastUpdated() string

func (*DefaultCostAccess) GetRoleArn added in v0.57.5

func (x *DefaultCostAccess) GetRoleArn() string

func (*DefaultCostAccess) GetStackId added in v0.57.5

func (x *DefaultCostAccess) GetStackId() string

func (*DefaultCostAccess) GetStackRegion added in v0.57.5

func (x *DefaultCostAccess) GetStackRegion() string

func (*DefaultCostAccess) GetStatus added in v0.57.5

func (x *DefaultCostAccess) GetStatus() string

func (*DefaultCostAccess) GetTarget added in v0.57.5

func (x *DefaultCostAccess) GetTarget() string

func (*DefaultCostAccess) GetTemplateUrl added in v0.57.5

func (x *DefaultCostAccess) GetTemplateUrl() string

func (*DefaultCostAccess) ProtoMessage added in v0.57.5

func (*DefaultCostAccess) ProtoMessage()

func (*DefaultCostAccess) ProtoReflect added in v0.57.5

func (x *DefaultCostAccess) ProtoReflect() protoreflect.Message

func (*DefaultCostAccess) Reset added in v0.57.5

func (x *DefaultCostAccess) Reset()

func (*DefaultCostAccess) String added in v0.57.5

func (x *DefaultCostAccess) String() string

type DeleteDefaultCostAccessRequest added in v0.57.5

type DeleteDefaultCostAccessRequest struct {

	// Required. The target AWS account to delete.
	Target string `protobuf:"bytes,1,opt,name=target,proto3" json:"target,omitempty"`
	// contains filtered or unexported fields
}

Request message for the Admin.DeleteDefaultCostAccess rpc.

func (*DeleteDefaultCostAccessRequest) Descriptor deprecated added in v0.57.5

func (*DeleteDefaultCostAccessRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteDefaultCostAccessRequest.ProtoReflect.Descriptor instead.

func (*DeleteDefaultCostAccessRequest) GetTarget added in v0.57.5

func (x *DeleteDefaultCostAccessRequest) GetTarget() string

func (*DeleteDefaultCostAccessRequest) ProtoMessage added in v0.57.5

func (*DeleteDefaultCostAccessRequest) ProtoMessage()

func (*DeleteDefaultCostAccessRequest) ProtoReflect added in v0.57.5

func (*DeleteDefaultCostAccessRequest) Reset added in v0.57.5

func (x *DeleteDefaultCostAccessRequest) Reset()

func (*DeleteDefaultCostAccessRequest) String added in v0.57.5

type DeleteNotificationChannelRequest added in v0.56.1

type DeleteNotificationChannelRequest struct {

	//Required. ID of Notification Channel to delete
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

Request message for Admin.DeleteNotificationChannel rpc

func (*DeleteNotificationChannelRequest) Descriptor deprecated added in v0.56.1

func (*DeleteNotificationChannelRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteNotificationChannelRequest.ProtoReflect.Descriptor instead.

func (*DeleteNotificationChannelRequest) GetId added in v0.56.1

func (*DeleteNotificationChannelRequest) ProtoMessage added in v0.56.1

func (*DeleteNotificationChannelRequest) ProtoMessage()

func (*DeleteNotificationChannelRequest) ProtoReflect added in v0.56.1

func (*DeleteNotificationChannelRequest) Reset added in v0.56.1

func (*DeleteNotificationChannelRequest) String added in v0.56.1

type GetAccountGroupRequest added in v0.36.3

type GetAccountGroupRequest struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

Request message for the Admin.GetAccountGroup rpc.

func (*GetAccountGroupRequest) Descriptor deprecated added in v0.36.3

func (*GetAccountGroupRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetAccountGroupRequest.ProtoReflect.Descriptor instead.

func (*GetAccountGroupRequest) GetId added in v0.36.3

func (x *GetAccountGroupRequest) GetId() string

func (*GetAccountGroupRequest) ProtoMessage added in v0.36.3

func (*GetAccountGroupRequest) ProtoMessage()

func (*GetAccountGroupRequest) ProtoReflect added in v0.36.3

func (x *GetAccountGroupRequest) ProtoReflect() protoreflect.Message

func (*GetAccountGroupRequest) Reset added in v0.36.3

func (x *GetAccountGroupRequest) Reset()

func (*GetAccountGroupRequest) String added in v0.36.3

func (x *GetAccountGroupRequest) String() string

type GetAccountGroupResponse added in v0.36.3

type GetAccountGroupResponse struct {
	AcctGroup *api.AccountGroup `protobuf:"bytes,1,opt,name=acctGroup,proto3" json:"acctGroup,omitempty"`
	// contains filtered or unexported fields
}

Response message for the Admin.GetAccountGroup rpc.

func (*GetAccountGroupResponse) Descriptor deprecated added in v0.36.3

func (*GetAccountGroupResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetAccountGroupResponse.ProtoReflect.Descriptor instead.

func (*GetAccountGroupResponse) GetAcctGroup added in v0.36.3

func (x *GetAccountGroupResponse) GetAcctGroup() *api.AccountGroup

func (*GetAccountGroupResponse) ProtoMessage added in v0.36.3

func (*GetAccountGroupResponse) ProtoMessage()

func (*GetAccountGroupResponse) ProtoReflect added in v0.36.3

func (x *GetAccountGroupResponse) ProtoReflect() protoreflect.Message

func (*GetAccountGroupResponse) Reset added in v0.36.3

func (x *GetAccountGroupResponse) Reset()

func (*GetAccountGroupResponse) String added in v0.36.3

func (x *GetAccountGroupResponse) String() string

type GetDefaultCostAccessRequest added in v0.57.5

type GetDefaultCostAccessRequest struct {

	// Required. The target AWS account to query.
	Target string `protobuf:"bytes,1,opt,name=target,proto3" json:"target,omitempty"`
	// contains filtered or unexported fields
}

Request message for the Admin.GetDefaultCostAccess rpc.

func (*GetDefaultCostAccessRequest) Descriptor deprecated added in v0.57.5

func (*GetDefaultCostAccessRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetDefaultCostAccessRequest.ProtoReflect.Descriptor instead.

func (*GetDefaultCostAccessRequest) GetTarget added in v0.57.5

func (x *GetDefaultCostAccessRequest) GetTarget() string

func (*GetDefaultCostAccessRequest) ProtoMessage added in v0.57.5

func (*GetDefaultCostAccessRequest) ProtoMessage()

func (*GetDefaultCostAccessRequest) ProtoReflect added in v0.57.5

func (*GetDefaultCostAccessRequest) Reset added in v0.57.5

func (x *GetDefaultCostAccessRequest) Reset()

func (*GetDefaultCostAccessRequest) String added in v0.57.5

func (x *GetDefaultCostAccessRequest) String() string

type GetDefaultCostAccessTemplateUrlRequest added in v0.57.5

type GetDefaultCostAccessTemplateUrlRequest struct {

	// Optional. Valid values are `default`, `s3only`, and `apionly`. Defaults to `default` if empty.
	//
	// `default` - Template for setting up both CUR export and read-only access to cost information. If selected, you need to
	// deploy this template to `us-east-1` region as CloudFormation only supports the `AWS::CUR::ReportDefinition` in that
	// region at the moment. The target S3 bucket will also be created in that region. If you prefer your S3 bucket to be located
	// in a different region, you can use the template from this API by setting the type to `s3only`. After your S3 bucket is
	// ready, call this API again (type is `default`) and set the `CurS3BucketOption` parameter to `USE_EXISTING`, then set your
	// bucket name and region accordingly. This is the default for Ripple, unless specified otherwise.
	//
	// `apionly` - Template for setting up ready-only access to cost information. Handy if you already have exported your CUR to
	// Alphaus through other means (i.e. manual setup). This template is the same as the `default` type but without the CUR
	// export definitions. Although not required, we recommend you to deploy this template to allow us to query your cost-related
	// information such as Reserved Instances, Saving Plans, etc. through the AWS API. At the moment, we only rely on CUR data
	// which is a best-effort basis and sometimes not accurate. This is the default for Wave(Pro), unless specified otherwise.
	//
	// `s3only` - A helper template for creating an S3 bucket to be used for CUR export.
	//
	// All templates are publicly available from the reponse link (`templateUrl`) if you want to audit the included permissions.
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// contains filtered or unexported fields
}

Request message for the Admin.GetDefaultCostAccessTemplateUrl rpc.

func (*GetDefaultCostAccessTemplateUrlRequest) Descriptor deprecated added in v0.57.5

func (*GetDefaultCostAccessTemplateUrlRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetDefaultCostAccessTemplateUrlRequest.ProtoReflect.Descriptor instead.

func (*GetDefaultCostAccessTemplateUrlRequest) GetType added in v0.57.5

func (*GetDefaultCostAccessTemplateUrlRequest) ProtoMessage added in v0.57.5

func (*GetDefaultCostAccessTemplateUrlRequest) ProtoReflect added in v0.57.5

func (*GetDefaultCostAccessTemplateUrlRequest) Reset added in v0.57.5

func (*GetDefaultCostAccessTemplateUrlRequest) String added in v0.57.5

type GetDefaultCostAccessTemplateUrlResponse added in v0.57.5

type GetDefaultCostAccessTemplateUrlResponse struct {

	// The CloudFormation launch url. Open it in your browser.
	LaunchUrl string `protobuf:"bytes,1,opt,name=launchUrl,proto3" json:"launchUrl,omitempty"`
	// The latest CloudFormation template. The version is included in the filename.
	TemplateUrl string `protobuf:"bytes,2,opt,name=templateUrl,proto3" json:"templateUrl,omitempty"`
	// The default stack name used. Can be modified.
	StackName string `protobuf:"bytes,3,opt,name=stackName,proto3" json:"stackName,omitempty"`
	// The AWS account that will receive the access. Do not change.
	Principal string `protobuf:"bytes,4,opt,name=principal,proto3" json:"principal,omitempty"`
	// contains filtered or unexported fields
}

Response message for the Admin.GetDefaultCostAccessTemplateUrl rpc.

func (*GetDefaultCostAccessTemplateUrlResponse) Descriptor deprecated added in v0.57.5

func (*GetDefaultCostAccessTemplateUrlResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetDefaultCostAccessTemplateUrlResponse.ProtoReflect.Descriptor instead.

func (*GetDefaultCostAccessTemplateUrlResponse) GetLaunchUrl added in v0.57.5

func (*GetDefaultCostAccessTemplateUrlResponse) GetPrincipal added in v0.57.5

func (*GetDefaultCostAccessTemplateUrlResponse) GetStackName added in v0.57.5

func (*GetDefaultCostAccessTemplateUrlResponse) GetTemplateUrl added in v0.57.5

func (x *GetDefaultCostAccessTemplateUrlResponse) GetTemplateUrl() string

func (*GetDefaultCostAccessTemplateUrlResponse) ProtoMessage added in v0.57.5

func (*GetDefaultCostAccessTemplateUrlResponse) ProtoReflect added in v0.57.5

func (*GetDefaultCostAccessTemplateUrlResponse) Reset added in v0.57.5

func (*GetDefaultCostAccessTemplateUrlResponse) String added in v0.57.5

type GetNotificationChannelRequest added in v0.56.1

type GetNotificationChannelRequest struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

Request message for Admin.GetNotificationChannel rpc

func (*GetNotificationChannelRequest) Descriptor deprecated added in v0.56.1

func (*GetNotificationChannelRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetNotificationChannelRequest.ProtoReflect.Descriptor instead.

func (*GetNotificationChannelRequest) GetId added in v0.56.1

func (*GetNotificationChannelRequest) ProtoMessage added in v0.56.1

func (*GetNotificationChannelRequest) ProtoMessage()

func (*GetNotificationChannelRequest) ProtoReflect added in v0.56.1

func (*GetNotificationChannelRequest) Reset added in v0.56.1

func (x *GetNotificationChannelRequest) Reset()

func (*GetNotificationChannelRequest) String added in v0.56.1

type GetNotificationSettingsRequest added in v0.56.1

type GetNotificationSettingsRequest struct {
	// contains filtered or unexported fields
}

Request message for Admin.GetNotificationSettings rpc

func (*GetNotificationSettingsRequest) Descriptor deprecated added in v0.56.1

func (*GetNotificationSettingsRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetNotificationSettingsRequest.ProtoReflect.Descriptor instead.

func (*GetNotificationSettingsRequest) ProtoMessage added in v0.56.1

func (*GetNotificationSettingsRequest) ProtoMessage()

func (*GetNotificationSettingsRequest) ProtoReflect added in v0.56.1

func (*GetNotificationSettingsRequest) Reset added in v0.56.1

func (x *GetNotificationSettingsRequest) Reset()

func (*GetNotificationSettingsRequest) String added in v0.56.1

type GrpcClient

type GrpcClient struct {
	AdminClient
	// contains filtered or unexported fields
}

func NewClient

func NewClient(ctx context.Context, opts ...*ClientOptions) (*GrpcClient, error)

NewClient returns a client connection to the 'admin' service.

func (*GrpcClient) Close

func (c *GrpcClient) Close()

type ListAccountGroupsRequest

type ListAccountGroupsRequest struct {
	// contains filtered or unexported fields
}

Request message for the Admin.ListAccountGroups rpc.

func (*ListAccountGroupsRequest) Descriptor deprecated

func (*ListAccountGroupsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListAccountGroupsRequest.ProtoReflect.Descriptor instead.

func (*ListAccountGroupsRequest) ProtoMessage

func (*ListAccountGroupsRequest) ProtoMessage()

func (*ListAccountGroupsRequest) ProtoReflect

func (x *ListAccountGroupsRequest) ProtoReflect() protoreflect.Message

func (*ListAccountGroupsRequest) Reset

func (x *ListAccountGroupsRequest) Reset()

func (*ListAccountGroupsRequest) String

func (x *ListAccountGroupsRequest) String() string

type ListAccountGroupsResponse

type ListAccountGroupsResponse struct {
	AccountGroups []*api.AccountGroup `protobuf:"bytes,1,rep,name=accountGroups,proto3" json:"accountGroups,omitempty"`
	// contains filtered or unexported fields
}

Response message for the Admin.ListAccountGroups rpc.

func (*ListAccountGroupsResponse) Descriptor deprecated

func (*ListAccountGroupsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListAccountGroupsResponse.ProtoReflect.Descriptor instead.

func (*ListAccountGroupsResponse) GetAccountGroups added in v0.36.1

func (x *ListAccountGroupsResponse) GetAccountGroups() []*api.AccountGroup

func (*ListAccountGroupsResponse) ProtoMessage

func (*ListAccountGroupsResponse) ProtoMessage()

func (*ListAccountGroupsResponse) ProtoReflect

func (*ListAccountGroupsResponse) Reset

func (x *ListAccountGroupsResponse) Reset()

func (*ListAccountGroupsResponse) String

func (x *ListAccountGroupsResponse) String() string

type ListDefaultCostAccessRequest added in v0.57.5

type ListDefaultCostAccessRequest struct {
	// contains filtered or unexported fields
}

Request message for the Admin.ListDefaultCostAccess rpc.

func (*ListDefaultCostAccessRequest) Descriptor deprecated added in v0.57.5

func (*ListDefaultCostAccessRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListDefaultCostAccessRequest.ProtoReflect.Descriptor instead.

func (*ListDefaultCostAccessRequest) ProtoMessage added in v0.57.5

func (*ListDefaultCostAccessRequest) ProtoMessage()

func (*ListDefaultCostAccessRequest) ProtoReflect added in v0.57.5

func (*ListDefaultCostAccessRequest) Reset added in v0.57.5

func (x *ListDefaultCostAccessRequest) Reset()

func (*ListDefaultCostAccessRequest) String added in v0.57.5

type ListNotificationChannelsRequest added in v0.56.1

type ListNotificationChannelsRequest struct {
	// contains filtered or unexported fields
}

Request message for Admin.ListNotificationChannels rpc

func (*ListNotificationChannelsRequest) Descriptor deprecated added in v0.56.1

func (*ListNotificationChannelsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListNotificationChannelsRequest.ProtoReflect.Descriptor instead.

func (*ListNotificationChannelsRequest) ProtoMessage added in v0.56.1

func (*ListNotificationChannelsRequest) ProtoMessage()

func (*ListNotificationChannelsRequest) ProtoReflect added in v0.56.1

func (*ListNotificationChannelsRequest) Reset added in v0.56.1

func (*ListNotificationChannelsRequest) String added in v0.56.1

type ListNotificationChannelsResponse added in v0.56.1

type ListNotificationChannelsResponse struct {
	Channels []*api.NotificationChannel `protobuf:"bytes,1,rep,name=channels,proto3" json:"channels,omitempty"`
	// contains filtered or unexported fields
}

Response message for Admin.ListNotificationChannels rpc

func (*ListNotificationChannelsResponse) Descriptor deprecated added in v0.56.1

func (*ListNotificationChannelsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListNotificationChannelsResponse.ProtoReflect.Descriptor instead.

func (*ListNotificationChannelsResponse) GetChannels added in v0.56.1

func (*ListNotificationChannelsResponse) ProtoMessage added in v0.56.1

func (*ListNotificationChannelsResponse) ProtoMessage()

func (*ListNotificationChannelsResponse) ProtoReflect added in v0.56.1

func (*ListNotificationChannelsResponse) Reset added in v0.56.1

func (*ListNotificationChannelsResponse) String added in v0.56.1

type SaveNotificationSettingsRequest added in v0.56.1

type SaveNotificationSettingsRequest struct {
	IsEnabled bool `protobuf:"varint,1,opt,name=isEnabled,proto3" json:"isEnabled,omitempty"`
	// contains filtered or unexported fields
}

Request message for Admin.SaveNotificationSettings rpc

func (*SaveNotificationSettingsRequest) Descriptor deprecated added in v0.56.1

func (*SaveNotificationSettingsRequest) Descriptor() ([]byte, []int)

Deprecated: Use SaveNotificationSettingsRequest.ProtoReflect.Descriptor instead.

func (*SaveNotificationSettingsRequest) GetIsEnabled added in v0.56.1

func (x *SaveNotificationSettingsRequest) GetIsEnabled() bool

func (*SaveNotificationSettingsRequest) ProtoMessage added in v0.56.1

func (*SaveNotificationSettingsRequest) ProtoMessage()

func (*SaveNotificationSettingsRequest) ProtoReflect added in v0.56.1

func (*SaveNotificationSettingsRequest) Reset added in v0.56.1

func (*SaveNotificationSettingsRequest) String added in v0.56.1

type UnimplementedAdminServer

type UnimplementedAdminServer struct {
}

UnimplementedAdminServer must be embedded to have forward compatible implementations.

func (UnimplementedAdminServer) CreateDefaultCostAccess added in v0.57.5

func (UnimplementedAdminServer) CreateNotificationChannel added in v0.56.1

func (UnimplementedAdminServer) DeleteDefaultCostAccess added in v0.57.5

func (UnimplementedAdminServer) DeleteNotificationChannel added in v0.56.1

func (UnimplementedAdminServer) GetAccountGroup added in v0.36.3

func (UnimplementedAdminServer) GetDefaultCostAccess added in v0.57.5

func (UnimplementedAdminServer) GetDefaultCostAccessTemplateUrl added in v0.57.5

func (UnimplementedAdminServer) GetNotificationChannel added in v0.56.1

func (UnimplementedAdminServer) GetNotificationSettings added in v0.56.1

func (UnimplementedAdminServer) ListDefaultCostAccess added in v0.57.5

func (UnimplementedAdminServer) ListNotificationChannels added in v0.56.1

func (UnimplementedAdminServer) SaveNotificationSettings added in v0.56.1

func (UnimplementedAdminServer) UpdateDefaultCostAccess added in v0.57.5

func (UnimplementedAdminServer) UpdateNotificationChannel added in v0.56.1

type UnsafeAdminServer

type UnsafeAdminServer interface {
	// contains filtered or unexported methods
}

UnsafeAdminServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to AdminServer will result in compilation errors.

type UpdateDefaultCostAccessRequest added in v0.57.5

type UpdateDefaultCostAccessRequest struct {

	// Required. The target AWS account to update.
	Target string `protobuf:"bytes,1,opt,name=target,proto3" json:"target,omitempty"`
	// contains filtered or unexported fields
}

Request message for the Admin.UpdateDefaultCostAccess rpc.

func (*UpdateDefaultCostAccessRequest) Descriptor deprecated added in v0.57.5

func (*UpdateDefaultCostAccessRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateDefaultCostAccessRequest.ProtoReflect.Descriptor instead.

func (*UpdateDefaultCostAccessRequest) GetTarget added in v0.57.5

func (x *UpdateDefaultCostAccessRequest) GetTarget() string

func (*UpdateDefaultCostAccessRequest) ProtoMessage added in v0.57.5

func (*UpdateDefaultCostAccessRequest) ProtoMessage()

func (*UpdateDefaultCostAccessRequest) ProtoReflect added in v0.57.5

func (*UpdateDefaultCostAccessRequest) Reset added in v0.57.5

func (x *UpdateDefaultCostAccessRequest) Reset()

func (*UpdateDefaultCostAccessRequest) String added in v0.57.5

type UpdateNotificationChannelRequest added in v0.56.1

type UpdateNotificationChannelRequest struct {

	//Required. ID of Notification Channel to update
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Required. Name of Notification Channel
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Required.
	// Valid values: "email", "slack", "msteams"
	Type string `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"`
	// Required if type="email"
	Email *api.EmailChannel `protobuf:"bytes,4,opt,name=email,proto3" json:"email,omitempty"`
	// Required if type="slack"
	Slack *api.SlackChannel `protobuf:"bytes,5,opt,name=slack,proto3" json:"slack,omitempty"`
	// Required if type="msteams"
	Msteams *api.MSTeamsChannel `protobuf:"bytes,6,opt,name=msteams,proto3" json:"msteams,omitempty"`
	// contains filtered or unexported fields
}

Request message for Admin.UpdateNotificationChannel rpc

func (*UpdateNotificationChannelRequest) Descriptor deprecated added in v0.56.1

func (*UpdateNotificationChannelRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateNotificationChannelRequest.ProtoReflect.Descriptor instead.

func (*UpdateNotificationChannelRequest) GetEmail added in v0.56.1

func (*UpdateNotificationChannelRequest) GetId added in v0.56.1

func (*UpdateNotificationChannelRequest) GetMsteams added in v0.56.1

func (*UpdateNotificationChannelRequest) GetName added in v0.56.1

func (*UpdateNotificationChannelRequest) GetSlack added in v0.56.1

func (*UpdateNotificationChannelRequest) GetType added in v0.56.1

func (*UpdateNotificationChannelRequest) ProtoMessage added in v0.56.1

func (*UpdateNotificationChannelRequest) ProtoMessage()

func (*UpdateNotificationChannelRequest) ProtoReflect added in v0.56.1

func (*UpdateNotificationChannelRequest) Reset added in v0.56.1

func (*UpdateNotificationChannelRequest) String added in v0.56.1

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL