models

package
v0.5.0 Latest Latest
Warning

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

Go to latest
Published: Apr 10, 2020 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source
const (

	// AccountAccountStatusReady captures enum value "Ready"
	AccountAccountStatusReady string = "Ready"

	// AccountAccountStatusNotReady captures enum value "NotReady"
	AccountAccountStatusNotReady string = "NotReady"

	// AccountAccountStatusLeased captures enum value "Leased"
	AccountAccountStatusLeased string = "Leased"

	// AccountAccountStatusOrphaned captures enum value "Orphaned"
	AccountAccountStatusOrphaned string = "Orphaned"
)
View Source
const (

	// LeaseLeaseStatusActive captures enum value "Active"
	LeaseLeaseStatusActive string = "Active"

	// LeaseLeaseStatusInactive captures enum value "Inactive"
	LeaseLeaseStatusInactive string = "Inactive"
)
View Source
const (

	// LeaseLeaseStatusReasonLeaseExpired captures enum value "LeaseExpired"
	LeaseLeaseStatusReasonLeaseExpired string = "LeaseExpired"

	// LeaseLeaseStatusReasonLeaseOverBudget captures enum value "LeaseOverBudget"
	LeaseLeaseStatusReasonLeaseOverBudget string = "LeaseOverBudget"

	// LeaseLeaseStatusReasonLeaseDestroyed captures enum value "LeaseDestroyed"
	LeaseLeaseStatusReasonLeaseDestroyed string = "LeaseDestroyed"

	// LeaseLeaseStatusReasonLeaseActive captures enum value "LeaseActive"
	LeaseLeaseStatusReasonLeaseActive string = "LeaseActive"

	// LeaseLeaseStatusReasonLeaseRolledBack captures enum value "LeaseRolledBack"
	LeaseLeaseStatusReasonLeaseRolledBack string = "LeaseRolledBack"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Account

type Account struct {

	// Status of the Account.
	// "Ready": The account is clean and ready for lease
	// "NotReady": The account is in "dirty" state, and needs to be reset before it may be leased.
	// "Leased": The account is leased to a principal
	//
	// Enum: [Ready NotReady Leased Orphaned]
	AccountStatus string `json:"accountStatus,omitempty"`

	// ARN for an IAM role within this AWS account. The DCE master account will assume this IAM role to execute operations within this AWS account. This IAM role is configured by the client, and must be configured with [a Trust Relationship with the DCE master account.](/https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html)
	AdminRoleArn string `json:"adminRoleArn,omitempty"`

	// Epoch timestamp, when account record was created
	CreatedOn int64 `json:"createdOn,omitempty"`

	// AWS Account ID
	ID string `json:"id,omitempty"`

	// Epoch timestamp, when account record was last modified
	LastModifiedOn int64 `json:"lastModifiedOn,omitempty"`

	// Any organization specific data pertaining to the account that needs to be persisted
	Metadata interface{} `json:"metadata,omitempty"`

	// The S3 object ETag used to apply the Principal IAM Policy within this AWS account.  This policy is created by the DCE master account, and is assumed by people with access to principalRoleArn.
	PrincipalPolicyHash string `json:"principalPolicyHash,omitempty"`

	// ARN for an IAM role within this AWS account. This role is created by the DCE master account, and may be assumed by principals to login to their AWS child account.
	PrincipalRoleArn string `json:"principalRoleArn,omitempty"`
}

Account Account Details swagger:model account

func (*Account) MarshalBinary

func (m *Account) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Account) UnmarshalBinary

func (m *Account) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Account) Validate

func (m *Account) Validate(formats strfmt.Registry) error

Validate validates this account

type AccountStatus

type AccountStatus string

AccountStatus Status of the Account. "Ready": The account is clean and ready for lease "NotReady": The account is in "dirty" state, and needs to be reset before it may be leased. "Leased": The account is leased to a principal

swagger:model accountStatus

const (

	// AccountStatusReady captures enum value "Ready"
	AccountStatusReady AccountStatus = "Ready"

	// AccountStatusNotReady captures enum value "NotReady"
	AccountStatusNotReady AccountStatus = "NotReady"

	// AccountStatusLeased captures enum value "Leased"
	AccountStatusLeased AccountStatus = "Leased"

	// AccountStatusOrphaned captures enum value "Orphaned"
	AccountStatusOrphaned AccountStatus = "Orphaned"
)

func (AccountStatus) Validate

func (m AccountStatus) Validate(formats strfmt.Registry) error

Validate validates this account status

type Lease

type Lease struct {

	// accountId of the AWS account
	AccountID string `json:"accountId,omitempty"`

	// budget amount
	BudgetAmount float64 `json:"budgetAmount,omitempty"`

	// budget currency
	BudgetCurrency string `json:"budgetCurrency,omitempty"`

	// budget notification emails
	BudgetNotificationEmails []string `json:"budgetNotificationEmails"`

	// creation date in epoch seconds
	CreatedOn float64 `json:"createdOn,omitempty"`

	// date lease should expire in epoch seconds
	ExpiresOn float64 `json:"expiresOn,omitempty"`

	// Lease ID
	ID string `json:"id,omitempty"`

	// date last modified in epoch seconds
	LastModifiedOn float64 `json:"lastModifiedOn,omitempty"`

	// Status of the Lease.
	// "Active": The principal is leased and has access to the account
	// "Inactive": The lease has become inactive, either through expiring, exceeding budget, or by request.
	//
	// Enum: [Active Inactive]
	LeaseStatus string `json:"leaseStatus,omitempty"`

	// date lease status was last modified in epoch seconds
	LeaseStatusModifiedOn float64 `json:"leaseStatusModifiedOn,omitempty"`

	// A reason behind the lease status.
	// "LeaseExpired": The lease exceeded its expiration time ("expiresOn") and
	// the associated account was reset and returned to the account pool.
	// "LeaseOverBudget": The lease exceeded its budgeted amount and the
	// associated account was reset and returned to the account pool.
	// "LeaseDestroyed": The lease was adminstratively ended, which can be done
	// via the leases API.
	// "LeaseActive": The lease is active.
	// "LeaseRolledBack": A system error occurred while provisioning the lease.
	// and it was rolled back.
	//
	// Enum: [LeaseExpired LeaseOverBudget LeaseDestroyed LeaseActive LeaseRolledBack]
	LeaseStatusReason string `json:"leaseStatusReason,omitempty"`

	// principalId of the lease to get
	PrincipalID string `json:"principalId,omitempty"`
}

Lease Lease Details swagger:model lease

func (*Lease) MarshalBinary

func (m *Lease) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Lease) UnmarshalBinary

func (m *Lease) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Lease) Validate

func (m *Lease) Validate(formats strfmt.Registry) error

Validate validates this lease

type LeaseAuth

type LeaseAuth struct {

	// Access Key ID for access to the AWS API
	AccessKeyID string `json:"accessKeyId,omitempty"`

	// URL to access the AWS Console
	ConsoleURL string `json:"consoleUrl,omitempty"`

	// expires on
	ExpiresOn float64 `json:"expiresOn,omitempty"`

	// Secret Access Key for access to the AWS API
	SecretAccessKey string `json:"secretAccessKey,omitempty"`

	// Session Token for access to the AWS API
	SessionToken string `json:"sessionToken,omitempty"`
}

LeaseAuth Lease Authentication swagger:model leaseAuth

func (*LeaseAuth) MarshalBinary

func (m *LeaseAuth) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LeaseAuth) UnmarshalBinary

func (m *LeaseAuth) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LeaseAuth) Validate

func (m *LeaseAuth) Validate(formats strfmt.Registry) error

Validate validates this lease auth

type LeaseStatus

type LeaseStatus string

LeaseStatus Status of the Lease. "Active": The principal is leased and has access to the account "Inactive": The lease has become inactive, either through expiring, exceeding budget, or by request.

swagger:model leaseStatus

const (

	// LeaseStatusActive captures enum value "Active"
	LeaseStatusActive LeaseStatus = "Active"

	// LeaseStatusInactive captures enum value "Inactive"
	LeaseStatusInactive LeaseStatus = "Inactive"
)

func (LeaseStatus) Validate

func (m LeaseStatus) Validate(formats strfmt.Registry) error

Validate validates this lease status

type LeaseStatusReason

type LeaseStatusReason string

LeaseStatusReason A reason behind the lease status. "LeaseExpired": The lease exceeded its expiration time ("expiresOn") and the associated account was reset and returned to the account pool. "LeaseOverBudget": The lease exceeded its budgeted amount and the associated account was reset and returned to the account pool. "LeaseDestroyed": The lease was adminstratively ended, which can be done via the leases API. "LeaseActive": The lease is active. "LeaseRolledBack": A system error occurred while provisioning the lease. and it was rolled back.

swagger:model leaseStatusReason

const (

	// LeaseStatusReasonLeaseExpired captures enum value "LeaseExpired"
	LeaseStatusReasonLeaseExpired LeaseStatusReason = "LeaseExpired"

	// LeaseStatusReasonLeaseOverBudget captures enum value "LeaseOverBudget"
	LeaseStatusReasonLeaseOverBudget LeaseStatusReason = "LeaseOverBudget"

	// LeaseStatusReasonLeaseDestroyed captures enum value "LeaseDestroyed"
	LeaseStatusReasonLeaseDestroyed LeaseStatusReason = "LeaseDestroyed"

	// LeaseStatusReasonLeaseActive captures enum value "LeaseActive"
	LeaseStatusReasonLeaseActive LeaseStatusReason = "LeaseActive"

	// LeaseStatusReasonLeaseRolledBack captures enum value "LeaseRolledBack"
	LeaseStatusReasonLeaseRolledBack LeaseStatusReason = "LeaseRolledBack"
)

func (LeaseStatusReason) Validate

func (m LeaseStatusReason) Validate(formats strfmt.Registry) error

Validate validates this lease status reason

type Usage

type Usage struct {

	// accountId of the AWS account
	AccountID string `json:"accountId,omitempty"`

	// usage cost Amount of AWS account for given period
	CostAmount float64 `json:"costAmount,omitempty"`

	// usage cost currency
	CostCurrency string `json:"costCurrency,omitempty"`

	// usage end date as Epoch Timestamp
	EndDate float64 `json:"endDate,omitempty"`

	// principalId of the user who owns the lease of the AWS account
	//
	PrincipalID string `json:"principalId,omitempty"`

	// usage start date as Epoch Timestamp
	StartDate float64 `json:"startDate,omitempty"`

	// ttl attribute as Epoch Timestamp
	TimeToLive float64 `json:"timeToLive,omitempty"`
}

Usage usage cost of the aws account from start date to end date swagger:model usage

func (*Usage) MarshalBinary

func (m *Usage) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Usage) UnmarshalBinary

func (m *Usage) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Usage) Validate

func (m *Usage) Validate(formats strfmt.Registry) error

Validate validates this usage

Jump to

Keyboard shortcuts

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