types

package
v0.0.0-...-68f2935 Latest Latest
Warning

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

 Go to latest Published: May 24, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type AlarmRecommendation 

type AlarmRecommendation struct {

	// Name of the alarm recommendation.
	//
	// This member is required.
	Name *string

	// Identifier of the alarm recommendation.
	//
	// This member is required.
	RecommendationId *string

	// Reference identifier of the alarm recommendation.
	//
	// This member is required.
	ReferenceId *string

	// Type of alarm recommendation.
	//
	// This member is required.
	Type AlarmType

	// Application Component name for the CloudWatch alarm recommendation. This name
	// is saved as the first item in the appComponentNames list.
	//
	// Deprecated: An alarm recommendation can be attached to multiple Application
	// Components, hence this property will be replaced by the new property
	// 'appComponentNames'.
	AppComponentName *string

	// List of Application Component names for the CloudWatch alarm recommendation.
	AppComponentNames []string

	// Description of the alarm recommendation.
	Description *string

	// List of CloudWatch alarm recommendations.
	Items []RecommendationItem

	// The prerequisite for the alarm recommendation.
	Prerequisite *string

	// Status of the recommended Amazon CloudWatch alarm.
	RecommendationStatus RecommendationStatus
	// contains filtered or unexported fields
}

Defines a recommendation for a CloudWatch alarm.

type AlarmType 

type AlarmType string
const (
	AlarmTypeMetric    AlarmType = "Metric"
	AlarmTypeComposite AlarmType = "Composite"
	AlarmTypeCanary    AlarmType = "Canary"
	AlarmTypeLogs      AlarmType = "Logs"
	AlarmTypeEvent     AlarmType = "Event"
)

Enum values for AlarmType

func (AlarmType) Values 

func (AlarmType) Values() []AlarmType

Values returns all known values for AlarmType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type App 

type App struct {

	// Amazon Resource Name (ARN) of the Resilience Hub application. The format for
	// this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For
	// more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference
	// guide.
	//
	// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	//
	// This member is required.
	AppArn *string

	// Date and time when the app was created.
	//
	// This member is required.
	CreationTime *time.Time

	// Name for the application.
	//
	// This member is required.
	Name *string

	// Assessment execution schedule with 'Daily' or 'Disabled' values.
	AssessmentSchedule AppAssessmentScheduleType

	// Current status of compliance for the resiliency policy.
	ComplianceStatus AppComplianceStatusType

	// Optional description for an application.
	Description *string

	// Indicates if compliance drifts (deviations) were detected while running an
	// assessment for your application.
	DriftStatus AppDriftStatusType

	// The list of events you would like to subscribe and get notification for.
	// Currently, Resilience Hub supports notifications only for Drift detected and
	// Scheduled assessment failure events.
	EventSubscriptions []EventSubscription

	// Date and time the most recent compliance evaluation.
	LastAppComplianceEvaluationTime *time.Time

	// Indicates the last time that a drift was evaluated.
	LastDriftEvaluationTime *time.Time

	// Date and time the most recent resiliency score evaluation.
	LastResiliencyScoreEvaluationTime *time.Time

	// Defines the roles and credentials that Resilience Hub would use while creating
	// the application, importing its resources, and running an assessment.
	PermissionModel *PermissionModel

	// Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN
	// is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id
	// . For more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General
	// Reference guide.
	//
	// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	PolicyArn *string

	// Current resiliency score for the application.
	ResiliencyScore float64

	// Recovery Point Objective (RPO) in seconds.
	RpoInSecs *int32

	// Recovery Time Objective (RTO) in seconds.
	RtoInSecs *int32

	// Status of the application.
	Status AppStatusType

	// Tags assigned to the resource. A tag is a label that you assign to an Amazon
	// Web Services resource. Each tag consists of a key/value pair.
	Tags map[string]string
	// contains filtered or unexported fields
}

Defines an Resilience Hub application.

type AppAssessment 

type AppAssessment struct {

	// Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:
	// partition :resiliencehub: region : account :app-assessment/ app-id . For more
	// information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide.
	//
	// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	//
	// This member is required.
	AssessmentArn *string

	// Current status of the assessment for the resiliency policy.
	//
	// This member is required.
	AssessmentStatus AssessmentStatus

	// The entity that invoked the assessment.
	//
	// This member is required.
	Invoker AssessmentInvoker

	// Amazon Resource Name (ARN) of the Resilience Hub application. The format for
	// this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For
	// more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference
	// guide.
	//
	// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	AppArn *string

	// Version of an application.
	AppVersion *string

	// Name of the assessment.
	AssessmentName *string

	// Application compliance against the resiliency policy.
	Compliance map[string]DisruptionCompliance

	// Current status of the compliance for the resiliency policy.
	ComplianceStatus ComplianceStatus

	// Cost for the application.
	Cost *Cost

	// Indicates if compliance drifts (deviations) were detected while running an
	// assessment for your application.
	DriftStatus DriftStatus

	// End time for the action.
	EndTime *time.Time

	// Error or warning message from the assessment execution
	Message *string

	// Resiliency policy of an application.
	Policy *ResiliencyPolicy

	// Current resiliency score for an application.
	ResiliencyScore *ResiliencyScore

	//  A resource error object containing a list of errors retrieving an
	// application's resources.
	ResourceErrorsDetails *ResourceErrorsDetails

	// Starting time for the action.
	StartTime *time.Time

	// Tags assigned to the resource. A tag is a label that you assign to an Amazon
	// Web Services resource. Each tag consists of a key/value pair.
	Tags map[string]string

	// Version name of the published application.
	VersionName *string
	// contains filtered or unexported fields
}

Defines an application assessment.

type AppAssessmentScheduleType 

type AppAssessmentScheduleType string
const (
	AppAssessmentScheduleTypeDisabled AppAssessmentScheduleType = "Disabled"
	AppAssessmentScheduleTypeDaily    AppAssessmentScheduleType = "Daily"
)

Enum values for AppAssessmentScheduleType

func (AppAssessmentScheduleType) Values 

func (AppAssessmentScheduleType) Values() []AppAssessmentScheduleType

Values returns all known values for AppAssessmentScheduleType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AppAssessmentSummary 

type AppAssessmentSummary struct {

	// Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:
	// partition :resiliencehub: region : account :app-assessment/ app-id . For more
	// information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide.
	//
	// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	//
	// This member is required.
	AssessmentArn *string

	// Current status of the assessment for the resiliency policy.
	//
	// This member is required.
	AssessmentStatus AssessmentStatus

	// Amazon Resource Name (ARN) of the Resilience Hub application. The format for
	// this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For
	// more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference
	// guide.
	//
	// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	AppArn *string

	// Version of an application.
	AppVersion *string

	// Name of the assessment.
	AssessmentName *string

	// TCurrent status of compliance for the resiliency policy.
	ComplianceStatus ComplianceStatus

	// Cost for an application.
	Cost *Cost

	// Indicates if compliance drifts (deviations) were detected while running an
	// assessment for your application.
	DriftStatus DriftStatus

	// End time for the action.
	EndTime *time.Time

	// Entity that invoked the assessment.
	Invoker AssessmentInvoker

	// Message from the assessment run.
	Message *string

	// Current resiliency score for the application.
	ResiliencyScore float64

	// Starting time for the action.
	StartTime *time.Time

	// Name of an application version.
	VersionName *string
	// contains filtered or unexported fields
}

Defines an application assessment summary.

type AppComplianceStatusType 

type AppComplianceStatusType string
const (
	AppComplianceStatusTypePolicyBreached  AppComplianceStatusType = "PolicyBreached"
	AppComplianceStatusTypePolicyMet       AppComplianceStatusType = "PolicyMet"
	AppComplianceStatusTypeNotAssessed     AppComplianceStatusType = "NotAssessed"
	AppComplianceStatusTypeChangesDetected AppComplianceStatusType = "ChangesDetected"
)

Enum values for AppComplianceStatusType

func (AppComplianceStatusType) Values 

func (AppComplianceStatusType) Values() []AppComplianceStatusType

Values returns all known values for AppComplianceStatusType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AppComponent 

type AppComponent struct {

	// Name of the Application Component.
	//
	// This member is required.
	Name *string

	// The type of Application Component.
	//
	// This member is required.
	Type *string

	// Additional configuration parameters for an Resilience Hub application. If you
	// want to implement additionalInfo through the Resilience Hub console rather than
	// using an API call, see [Configure the application configuration parameters].
	//
	// Currently, this parameter accepts a key-value mapping (in a string format) of
	// only one failover region and one associated account.
	//
	// Key: "failover-regions"
	//
	// Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
	//
	// [Configure the application configuration parameters]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html
	AdditionalInfo map[string][]string

	// Identifier of the Application Component.
	Id *string
	// contains filtered or unexported fields
}

Defines an Application Component.

type AppComponentCompliance 

type AppComponentCompliance struct {

	// Name of the Application Component.
	AppComponentName *string

	// The compliance of the Application Component against the resiliency policy.
	Compliance map[string]DisruptionCompliance

	// The cost for the application.
	Cost *Cost

	// The compliance message.
	Message *string

	// The current resiliency score for the application.
	ResiliencyScore *ResiliencyScore

	// Status of the action.
	Status ComplianceStatus
	// contains filtered or unexported fields
}

Defines the compliance of an Application Component against the resiliency policy.

type AppDriftStatusType 

type AppDriftStatusType string
const (
	AppDriftStatusTypeNotChecked  AppDriftStatusType = "NotChecked"
	AppDriftStatusTypeNotDetected AppDriftStatusType = "NotDetected"
	AppDriftStatusTypeDetected    AppDriftStatusType = "Detected"
)

Enum values for AppDriftStatusType

func (AppDriftStatusType) Values 

func (AppDriftStatusType) Values() []AppDriftStatusType

Values returns all known values for AppDriftStatusType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AppInputSource 

type AppInputSource struct {

	// The resource type of the input source.
	//
	// This member is required.
	ImportType ResourceMappingType

	// The namespace on your Amazon Elastic Kubernetes Service cluster.
	EksSourceClusterNamespace *EksSourceClusterNamespace

	// The number of resources.
	ResourceCount int32

	// The Amazon Resource Name (ARN) of the input source. For more information about
	// ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide.
	//
	// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	SourceArn *string

	// The name of the input source.
	SourceName *string

	// The name of the Terraform s3 state file.
	TerraformSource *TerraformSource
	// contains filtered or unexported fields
}

The list of Resilience Hub application input sources.

type AppStatusType 

type AppStatusType string
const (
	AppStatusTypeActive   AppStatusType = "Active"
	AppStatusTypeDeleting AppStatusType = "Deleting"
)

Enum values for AppStatusType

func (AppStatusType) Values 

func (AppStatusType) Values() []AppStatusType

Values returns all known values for AppStatusType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AppSummary 

type AppSummary struct {

	// Amazon Resource Name (ARN) of the Resilience Hub application. The format for
	// this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For
	// more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference
	// guide.
	//
	// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	//
	// This member is required.
	AppArn *string

	// Date and time when the app was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The name of the application.
	//
	// This member is required.
	Name *string

	//  Assessment execution schedule with 'Daily' or 'Disabled' values.
	AssessmentSchedule AppAssessmentScheduleType

	// The current status of compliance for the resiliency policy.
	ComplianceStatus AppComplianceStatusType

	// The optional description for an app.
	Description *string

	// Indicates if compliance drifts (deviations) were detected while running an
	// assessment for your application.
	DriftStatus AppDriftStatusType

	// Date and time of the most recent compliance evaluation.
	LastAppComplianceEvaluationTime *time.Time

	// The current resiliency score for the application.
	ResiliencyScore float64

	// Recovery Point Objective (RPO) in seconds.
	RpoInSecs *int32

	// Recovery Time Objective (RTO) in seconds.
	RtoInSecs *int32

	// Status of the application.
	Status AppStatusType
	// contains filtered or unexported fields
}

Defines an application summary.

type AppVersionSummary 

type AppVersionSummary struct {

	// Version of an application.
	//
	// This member is required.
	AppVersion *string

	// Creation time of the application version.
	CreationTime *time.Time

	// Identifier of the application version.
	Identifier *int64

	// Name of the application version.
	VersionName *string
	// contains filtered or unexported fields
}

Version of an application.

type AssessmentInvoker 

type AssessmentInvoker string
const (
	AssessmentInvokerUser   AssessmentInvoker = "User"
	AssessmentInvokerSystem AssessmentInvoker = "System"
)

Enum values for AssessmentInvoker

func (AssessmentInvoker) Values 

func (AssessmentInvoker) Values() []AssessmentInvoker

Values returns all known values for AssessmentInvoker. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AssessmentStatus 

type AssessmentStatus string
const (
	AssessmentStatusPending    AssessmentStatus = "Pending"
	AssessmentStatusInprogress AssessmentStatus = "InProgress"
	AssessmentStatusFailed     AssessmentStatus = "Failed"
	AssessmentStatusSuccess    AssessmentStatus = "Success"
)

Enum values for AssessmentStatus

func (AssessmentStatus) Values 

func (AssessmentStatus) Values() []AssessmentStatus

Values returns all known values for AssessmentStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type BatchUpdateRecommendationStatusFailedEntry 

type BatchUpdateRecommendationStatusFailedEntry struct {

	// An identifier of an entry in this batch that is used to communicate the result.
	//
	// The entryId s of a batch request need to be unique within a request.
	//
	// This member is required.
	EntryId *string

	// Indicates the error that occurred while excluding an operational recommendation.
	//
	// This member is required.
	ErrorMessage *string
	// contains filtered or unexported fields
}

List of operational recommendations that did not get included or excluded.

type BatchUpdateRecommendationStatusSuccessfulEntry 

type BatchUpdateRecommendationStatusSuccessfulEntry struct {

	// An identifier for an entry in this batch that is used to communicate the result.
	//
	// The entryId s of a batch request need to be unique within a request.
	//
	// This member is required.
	EntryId *string

	// Indicates if the operational recommendation was successfully excluded.
	//
	// This member is required.
	Excluded *bool

	// The operational recommendation item.
	//
	// This member is required.
	Item *UpdateRecommendationStatusItem

	// Reference identifier of the operational recommendation.
	//
	// This member is required.
	ReferenceId *string

	// Indicates the reason for excluding an operational recommendation.
	ExcludeReason ExcludeRecommendationReason
	// contains filtered or unexported fields
}

List of operational recommendations that were successfully included or excluded.

type ComplianceDrift 

type ComplianceDrift struct {

	// Assessment identifier that is associated with this drift item.
	ActualReferenceId *string

	// Actual compliance value of the entity.
	ActualValue map[string]DisruptionCompliance

	// Identifier of your application.
	AppId *string

	// Published version of your application on which drift was detected.
	AppVersion *string

	// Difference type between actual and expected recovery point objective (RPO) and
	// recovery time objective (RTO) values. Currently, Resilience Hub supports only
	// NotEqual difference type.
	DiffType DifferenceType

	// The type of drift detected. Currently, Resilience Hub supports only
	// ApplicationCompliance drift type.
	DriftType DriftType

	// Identifier of an entity in which drift was detected. For compliance drift, the
	// entity ID can be either application ID or the AppComponent ID.
	EntityId *string

	// The type of entity in which drift was detected. For compliance drifts,
	// Resilience Hub supports AWS::ResilienceHub::AppComponent and
	// AWS::ResilienceHub::Application .
	EntityType *string

	// Assessment identifier of a previous assessment of the same application version.
	// Resilience Hub uses the previous assessment (associated with the reference
	// identifier) to compare the compliance with the current assessment to identify
	// drifts.
	ExpectedReferenceId *string

	// The expected compliance value of an entity.
	ExpectedValue map[string]DisruptionCompliance
	// contains filtered or unexported fields
}

Indicates the compliance drifts (recovery time objective (RTO) and recovery point objective (RPO)) that were detected for an assessed entity.

type ComplianceStatus 

type ComplianceStatus string
const (
	ComplianceStatusPolicyBreached ComplianceStatus = "PolicyBreached"
	ComplianceStatusPolicyMet      ComplianceStatus = "PolicyMet"
)

Enum values for ComplianceStatus

func (ComplianceStatus) Values 

func (ComplianceStatus) Values() []ComplianceStatus

Values returns all known values for ComplianceStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ComponentRecommendation 

type ComponentRecommendation struct {

	// Name of the Application Component.
	//
	// This member is required.
	AppComponentName *string

	// List of recommendations.
	//
	// This member is required.
	ConfigRecommendations []ConfigRecommendation

	// Status of the recommendation.
	//
	// This member is required.
	RecommendationStatus RecommendationComplianceStatus
	// contains filtered or unexported fields
}

Defines recommendations for an Resilience Hub Application Component, returned as an object. This object contains component names, configuration recommendations, and recommendation statuses.

type ConfigRecommendation 

type ConfigRecommendation struct {

	// The name of the recommendation configuration.
	//
	// This member is required.
	Name *string

	// The type of optimization.
	//
	// This member is required.
	OptimizationType ConfigRecommendationOptimizationType

	// Reference identifier for the recommendation configuration.
	//
	// This member is required.
	ReferenceId *string

	// Name of the Application Component.
	AppComponentName *string

	// The current compliance against the resiliency policy before applying the
	// configuration change.
	Compliance map[string]DisruptionCompliance

	// The cost for the application.
	Cost *Cost

	// The optional description for an app.
	Description *string

	// The architecture type.
	HaArchitecture HaArchitecture

	// The expected compliance against the resiliency policy after applying the
	// configuration change.
	RecommendationCompliance map[string]RecommendationDisruptionCompliance

	// List of the suggested configuration changes.
	SuggestedChanges []string
	// contains filtered or unexported fields
}

Defines a recommendation configuration.

type ConfigRecommendationOptimizationType 

type ConfigRecommendationOptimizationType string
const (
	ConfigRecommendationOptimizationTypeLeastCost          ConfigRecommendationOptimizationType = "LeastCost"
	ConfigRecommendationOptimizationTypeLeastChange        ConfigRecommendationOptimizationType = "LeastChange"
	ConfigRecommendationOptimizationTypeBestAzRecovery     ConfigRecommendationOptimizationType = "BestAZRecovery"
	ConfigRecommendationOptimizationTypeLeastErrors        ConfigRecommendationOptimizationType = "LeastErrors"
	ConfigRecommendationOptimizationTypeBestAttainable     ConfigRecommendationOptimizationType = "BestAttainable"
	ConfigRecommendationOptimizationTypeBestRegionRecovery ConfigRecommendationOptimizationType = "BestRegionRecovery"
)

Enum values for ConfigRecommendationOptimizationType

func (ConfigRecommendationOptimizationType) Values 

func (ConfigRecommendationOptimizationType) Values() []ConfigRecommendationOptimizationType

Values returns all known values for ConfigRecommendationOptimizationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

This exception occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type Cost 

type Cost struct {

	// The cost amount.
	//
	// This member is required.
	Amount float64

	// The cost currency, for example USD .
	//
	// This member is required.
	Currency *string

	// The cost frequency.
	//
	// This member is required.
	Frequency CostFrequency
	// contains filtered or unexported fields
}

Defines a cost object.

type CostFrequency 

type CostFrequency string
const (
	CostFrequencyHourly  CostFrequency = "Hourly"
	CostFrequencyDaily   CostFrequency = "Daily"
	CostFrequencyMonthly CostFrequency = "Monthly"
	CostFrequencyYearly  CostFrequency = "Yearly"
)

Enum values for CostFrequency

func (CostFrequency) Values 

func (CostFrequency) Values() []CostFrequency

Values returns all known values for CostFrequency. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DataLocationConstraint 

type DataLocationConstraint string
const (
	DataLocationConstraintAnyLocation   DataLocationConstraint = "AnyLocation"
	DataLocationConstraintSameContinent DataLocationConstraint = "SameContinent"
	DataLocationConstraintSameCountry   DataLocationConstraint = "SameCountry"
)

Enum values for DataLocationConstraint

func (DataLocationConstraint) Values 

func (DataLocationConstraint) Values() []DataLocationConstraint

Values returns all known values for DataLocationConstraint. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DifferenceType 

type DifferenceType string
const (
	DifferenceTypeNotEqual DifferenceType = "NotEqual"
	DifferenceTypeAdded    DifferenceType = "Added"
	DifferenceTypeRemoved  DifferenceType = "Removed"
)

Enum values for DifferenceType

func (DifferenceType) Values 

func (DifferenceType) Values() []DifferenceType

Values returns all known values for DifferenceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DisruptionCompliance 

type DisruptionCompliance struct {

	// The current status of compliance for the resiliency policy.
	//
	// This member is required.
	ComplianceStatus ComplianceStatus

	// The Recovery Point Objective (RPO) that is achievable, in seconds.
	AchievableRpoInSecs int32

	// The Recovery Time Objective (RTO) that is achievable, in seconds
	AchievableRtoInSecs int32

	// The current RPO, in seconds.
	CurrentRpoInSecs int32

	// The current RTO, in seconds.
	CurrentRtoInSecs int32

	// The disruption compliance message.
	Message *string

	// The RPO description.
	RpoDescription *string

	// Reference identifier of the RPO .
	RpoReferenceId *string

	// The RTO description.
	RtoDescription *string

	// Reference identifier of the RTO.
	RtoReferenceId *string
	// contains filtered or unexported fields
}

Defines the compliance against the resiliency policy for a disruption.

type DisruptionType 

type DisruptionType string
const (
	DisruptionTypeSoftware DisruptionType = "Software"
	DisruptionTypeHardware DisruptionType = "Hardware"
	DisruptionTypeAz       DisruptionType = "AZ"
	DisruptionTypeRegion   DisruptionType = "Region"
)

Enum values for DisruptionType

func (DisruptionType) Values 

func (DisruptionType) Values() []DisruptionType

Values returns all known values for DisruptionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DriftStatus 

type DriftStatus string
const (
	DriftStatusNotChecked  DriftStatus = "NotChecked"
	DriftStatusNotDetected DriftStatus = "NotDetected"
	DriftStatusDetected    DriftStatus = "Detected"
)

Enum values for DriftStatus

func (DriftStatus) Values 

func (DriftStatus) Values() []DriftStatus

Values returns all known values for DriftStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DriftType 

type DriftType string
const (
	DriftTypeApplicationCompliance                  DriftType = "ApplicationCompliance"
	DriftTypeAppComponentResiliencyComplianceStatus DriftType = "AppComponentResiliencyComplianceStatus"
)

Enum values for DriftType

func (DriftType) Values 

func (DriftType) Values() []DriftType

Values returns all known values for DriftType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EksSource 

type EksSource struct {

	// Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster.
	// The format for this ARN is: arn: aws :eks: region : account-id :cluster/
	// cluster-name . For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services
	// General Reference guide.
	//
	// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	//
	// This member is required.
	EksClusterArn *string

	// The list of namespaces located on your Amazon Elastic Kubernetes Service
	// cluster.
	//
	// This member is required.
	Namespaces []string
	// contains filtered or unexported fields
}

The input source of the Amazon Elastic Kubernetes Service cluster.

type EksSourceClusterNamespace 

type EksSourceClusterNamespace struct {

	// Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster.
	// The format for this ARN is: arn: aws :eks: region : account-id :cluster/
	// cluster-name . For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services
	// General Reference guide.
	//
	// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	//
	// This member is required.
	EksClusterArn *string

	// Name of the namespace that is located on your Amazon Elastic Kubernetes Service
	// cluster.
	//
	// This member is required.
	Namespace *string
	// contains filtered or unexported fields
}

The input source of the namespace that is located on your Amazon Elastic Kubernetes Service cluster.

type EstimatedCostTier 

type EstimatedCostTier string
const (
	EstimatedCostTierL1 EstimatedCostTier = "L1"
	EstimatedCostTierL2 EstimatedCostTier = "L2"
	EstimatedCostTierL3 EstimatedCostTier = "L3"
	EstimatedCostTierL4 EstimatedCostTier = "L4"
)

Enum values for EstimatedCostTier

func (EstimatedCostTier) Values 

func (EstimatedCostTier) Values() []EstimatedCostTier

Values returns all known values for EstimatedCostTier. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EventSubscription 

type EventSubscription struct {

	// The type of event you would like to subscribe and get notification for.
	// Currently, Resilience Hub supports notifications only for Drift detected (
	// DriftDetected ) and Scheduled assessment failure ( ScheduledAssessmentFailure )
	// events.
	//
	// This member is required.
	EventType EventType

	// Unique name to identify an event subscription.
	//
	// This member is required.
	Name *string

	// Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic. The
	// format for this ARN is: arn:partition:sns:region:account:topic-name . For more
	// information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide.
	//
	// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	SnsTopicArn *string
	// contains filtered or unexported fields
}

Indicates an event you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected and Scheduled assessment failure events.

type EventType 

type EventType string
const (
	EventTypeScheduledAssessmentFailure EventType = "ScheduledAssessmentFailure"
	EventTypeDriftDetected              EventType = "DriftDetected"
)

Enum values for EventType

func (EventType) Values 

func (EventType) Values() []EventType

Values returns all known values for EventType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ExcludeRecommendationReason 

type ExcludeRecommendationReason string
const (
	ExcludeRecommendationReasonAlreadyImplemented         ExcludeRecommendationReason = "AlreadyImplemented"
	ExcludeRecommendationReasonNotRelevant                ExcludeRecommendationReason = "NotRelevant"
	ExcludeRecommendationReasonComplexityOfImplementation ExcludeRecommendationReason = "ComplexityOfImplementation"
)

Enum values for ExcludeRecommendationReason

func (ExcludeRecommendationReason) Values 

func (ExcludeRecommendationReason) Values() []ExcludeRecommendationReason

Values returns all known values for ExcludeRecommendationReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FailurePolicy 

type FailurePolicy struct {

	// Recovery Point Objective (RPO) in seconds.
	//
	// This member is required.
	RpoInSecs int32

	// Recovery Time Objective (RTO) in seconds.
	//
	// This member is required.
	RtoInSecs int32
	// contains filtered or unexported fields
}

Defines a failure policy.

type HaArchitecture 

type HaArchitecture string
const (
	HaArchitectureMultiSite        HaArchitecture = "MultiSite"
	HaArchitectureWarmStandby      HaArchitecture = "WarmStandby"
	HaArchitecturePilotLight       HaArchitecture = "PilotLight"
	HaArchitectureBackupAndRestore HaArchitecture = "BackupAndRestore"
	HaArchitectureNoRecoveryPlan   HaArchitecture = "NoRecoveryPlan"
)

Enum values for HaArchitecture

func (HaArchitecture) Values 

func (HaArchitecture) Values() []HaArchitecture

Values returns all known values for HaArchitecture. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

This exception occurs when there is an internal failure in the Resilience Hub service.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type LogicalResourceId 

type LogicalResourceId struct {

	// Identifier of the resource.
	//
	// This member is required.
	Identifier *string

	// Name of the Amazon Elastic Kubernetes Service cluster and namespace this
	// resource belongs to.
	//
	// This parameter accepts values in "eks-cluster/namespace" format.
	EksSourceName *string

	// The name of the CloudFormation stack this resource belongs to.
	LogicalStackName *string

	// The name of the resource group that this resource belongs to.
	ResourceGroupName *string

	//  The name of the Terraform S3 state file this resource belongs to.
	TerraformSourceName *string
	// contains filtered or unexported fields
}

Defines a logical resource identifier.

type PermissionModel 

type PermissionModel struct {

	// Defines how Resilience Hub scans your resources. It can scan for the resources
	// by using a pre-existing role in your Amazon Web Services account, or by using
	// the credentials of the current IAM user.
	//
	// This member is required.
	Type PermissionModelType

	// Defines a list of role Amazon Resource Names (ARNs) to be used in other
	// accounts. These ARNs are used for querying purposes while importing resources
	// and assessing your application.
	//
	//   - These ARNs are required only when your resources are in other accounts and
	//   you have different role name in these accounts. Else, the invoker role name will
	//   be used in the other accounts.
	//
	//   - These roles must have a trust policy with iam:AssumeRole permission to the
	//   invoker role in the primary account.
	CrossAccountRoleArns []string

	// Existing Amazon Web Services IAM role name in the primary Amazon Web Services
	// account that will be assumed by Resilience Hub Service Principle to obtain a
	// read-only access to your application resources while running an assessment.
	//
	//   - You must have iam:passRole permission for this role while creating or
	//   updating the application.
	//
	//   - Currently, invokerRoleName accepts only [A-Za-z0-9_+=,.@-] characters.
	InvokerRoleName *string
	// contains filtered or unexported fields
}

Defines the roles and credentials that Resilience Hub would use while creating the application, importing its resources, and running an assessment.

type PermissionModelType 

type PermissionModelType string
const (
	PermissionModelTypeLegacyIamUser PermissionModelType = "LegacyIAMUser"
	PermissionModelTypeRoleBased     PermissionModelType = "RoleBased"
)

Enum values for PermissionModelType

func (PermissionModelType) Values 

func (PermissionModelType) Values() []PermissionModelType

Values returns all known values for PermissionModelType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PhysicalIdentifierType 

type PhysicalIdentifierType string
const (
	PhysicalIdentifierTypeArn    PhysicalIdentifierType = "Arn"
	PhysicalIdentifierTypeNative PhysicalIdentifierType = "Native"
)

Enum values for PhysicalIdentifierType

func (PhysicalIdentifierType) Values 

func (PhysicalIdentifierType) Values() []PhysicalIdentifierType

Values returns all known values for PhysicalIdentifierType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PhysicalResource 

type PhysicalResource struct {

	// Logical identifier of the resource.
	//
	// This member is required.
	LogicalResourceId *LogicalResourceId

	// Identifier of the physical resource.
	//
	// This member is required.
	PhysicalResourceId *PhysicalResourceId

	// Type of resource.
	//
	// This member is required.
	ResourceType *string

	// Additional configuration parameters for an Resilience Hub application. If you
	// want to implement additionalInfo through the Resilience Hub console rather than
	// using an API call, see [Configure the application configuration parameters].
	//
	// Currently, this parameter accepts a key-value mapping (in a string format) of
	// only one failover region and one associated account.
	//
	// Key: "failover-regions"
	//
	// Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
	//
	// [Configure the application configuration parameters]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html
	AdditionalInfo map[string][]string

	// The application components that belong to this resource.
	AppComponents []AppComponent

	// Indicates if a resource is included or excluded from the assessment.
	Excluded *bool

	// Name of the parent resource.
	ParentResourceName *string

	// The name of the resource.
	ResourceName *string

	// Type of input source.
	SourceType ResourceSourceType
	// contains filtered or unexported fields
}

Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or an Resilience Hub-native identifier.

type PhysicalResourceId 

type PhysicalResourceId struct {

	// Identifier of the physical resource.
	//
	// This member is required.
	Identifier *string

	// Specifies the type of physical resource identifier.
	//
	// Arn The resource identifier is an Amazon Resource Name (ARN) and it can
	// identify the following list of resources:
	//
	//   - AWS::ECS::Service
	//
	//   - AWS::EFS::FileSystem
	//
	//   - AWS::ElasticLoadBalancingV2::LoadBalancer
	//
	//   - AWS::Lambda::Function
	//
	//   - AWS::SNS::Topic
	//
	// Native The resource identifier is an Resilience Hub-native identifier and it
	// can identify the following list of resources:
	//
	//   - AWS::ApiGateway::RestApi
	//
	//   - AWS::ApiGatewayV2::Api
	//
	//   - AWS::AutoScaling::AutoScalingGroup
	//
	//   - AWS::DocDB::DBCluster
	//
	//   - AWS::DocDB::DBGlobalCluster
	//
	//   - AWS::DocDB::DBInstance
	//
	//   - AWS::DynamoDB::GlobalTable
	//
	//   - AWS::DynamoDB::Table
	//
	//   - AWS::EC2::EC2Fleet
	//
	//   - AWS::EC2::Instance
	//
	//   - AWS::EC2::NatGateway
	//
	//   - AWS::EC2::Volume
	//
	//   - AWS::ElasticLoadBalancing::LoadBalancer
	//
	//   - AWS::RDS::DBCluster
	//
	//   - AWS::RDS::DBInstance
	//
	//   - AWS::RDS::GlobalCluster
	//
	//   - AWS::Route53::RecordSet
	//
	//   - AWS::S3::Bucket
	//
	//   - AWS::SQS::Queue
	//
	// This member is required.
	Type PhysicalIdentifierType

	// The Amazon Web Services account that owns the physical resource.
	AwsAccountId *string

	// The Amazon Web Services Region that the physical resource is located in.
	AwsRegion *string
	// contains filtered or unexported fields
}

Defines a physical resource identifier.

type RecommendationComplianceStatus 

type RecommendationComplianceStatus string
const (
	RecommendationComplianceStatusBreachedUnattainable RecommendationComplianceStatus = "BreachedUnattainable"
	RecommendationComplianceStatusBreachedCanMeet      RecommendationComplianceStatus = "BreachedCanMeet"
	RecommendationComplianceStatusMetCanImprove        RecommendationComplianceStatus = "MetCanImprove"
)

Enum values for RecommendationComplianceStatus

func (RecommendationComplianceStatus) Values 

func (RecommendationComplianceStatus) Values() []RecommendationComplianceStatus

Values returns all known values for RecommendationComplianceStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RecommendationDisruptionCompliance 

type RecommendationDisruptionCompliance struct {

	// The expected compliance status after applying the recommended configuration
	// change.
	//
	// This member is required.
	ExpectedComplianceStatus ComplianceStatus

	// The expected Recovery Point Objective (RPO) description after applying the
	// recommended configuration change.
	ExpectedRpoDescription *string

	// The expected RPO after applying the recommended configuration change.
	ExpectedRpoInSecs int32

	// The expected Recovery Time Objective (RTO) description after applying the
	// recommended configuration change.
	ExpectedRtoDescription *string

	// The expected RTO after applying the recommended configuration change.
	ExpectedRtoInSecs int32
	// contains filtered or unexported fields
}

Defines a disruption compliance recommendation.

type RecommendationItem 

type RecommendationItem struct {

	// Specifies if the recommendation has already been implemented.
	AlreadyImplemented *bool

	// Indicates the reason for excluding an operational recommendation.
	ExcludeReason ExcludeRecommendationReason

	// Indicates if an operational recommendation item is excluded.
	Excluded *bool

	// Identifier of the resource.
	ResourceId *string

	// Identifier of the target account.
	TargetAccountId *string

	// The target region.
	TargetRegion *string
	// contains filtered or unexported fields
}

Defines a recommendation.

type RecommendationStatus 

type RecommendationStatus string
const (
	RecommendationStatusImplemented    RecommendationStatus = "Implemented"
	RecommendationStatusInactive       RecommendationStatus = "Inactive"
	RecommendationStatusNotImplemented RecommendationStatus = "NotImplemented"
	RecommendationStatusExcluded       RecommendationStatus = "Excluded"
)

Enum values for RecommendationStatus

func (RecommendationStatus) Values 

func (RecommendationStatus) Values() []RecommendationStatus

Values returns all known values for RecommendationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RecommendationTemplate 

type RecommendationTemplate struct {

	// Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:
	// partition :resiliencehub: region : account :app-assessment/ app-id . For more
	// information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide.
	//
	// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	//
	// This member is required.
	AssessmentArn *string

	// Format of the recommendation template.
	//
	// CfnJson The template is CloudFormation JSON.
	//
	// CfnYaml The template is CloudFormation YAML.
	//
	// This member is required.
	Format TemplateFormat

	// Name for the recommendation template.
	//
	// This member is required.
	Name *string

	// Amazon Resource Name (ARN) for the recommendation template.
	//
	// This member is required.
	RecommendationTemplateArn *string

	// An array of strings that specify the recommendation template type or types.
	//
	// Alarm The template is an AlarmRecommendation template.
	//
	// Sop The template is a SopRecommendation template.
	//
	// Test The template is a TestRecommendation template.
	//
	// This member is required.
	RecommendationTypes []RenderRecommendationType

	// Status of the action.
	//
	// This member is required.
	Status RecommendationTemplateStatus

	// Amazon Resource Name (ARN) of the Resilience Hub application. The format for
	// this ARN is: arn: partition :resiliencehub: region : account :app/ app-id . For
	// more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference
	// guide.
	//
	// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	AppArn *string

	// The end time for the action.
	EndTime *time.Time

	// Message for the recommendation template.
	Message *string

	// Indicates if replacements are needed.
	NeedsReplacements *bool

	// Identifiers for the recommendations used in the recommendation template.
	RecommendationIds []string

	// The start time for the action.
	StartTime *time.Time

	// Tags assigned to the resource. A tag is a label that you assign to an Amazon
	// Web Services resource. Each tag consists of a key/value pair.
	Tags map[string]string

	// The file location of the template.
	TemplatesLocation *S3Location
	// contains filtered or unexported fields
}

Defines a recommendation template created with the CreateRecommendationTemplate action.

type RecommendationTemplateStatus 

type RecommendationTemplateStatus string
const (
	RecommendationTemplateStatusPending    RecommendationTemplateStatus = "Pending"
	RecommendationTemplateStatusInProgress RecommendationTemplateStatus = "InProgress"
	RecommendationTemplateStatusFailed     RecommendationTemplateStatus = "Failed"
	RecommendationTemplateStatusSuccess    RecommendationTemplateStatus = "Success"
)

Enum values for RecommendationTemplateStatus

func (RecommendationTemplateStatus) Values 

func (RecommendationTemplateStatus) Values() []RecommendationTemplateStatus

Values returns all known values for RecommendationTemplateStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RenderRecommendationType 

type RenderRecommendationType string
const (
	RenderRecommendationTypeAlarm RenderRecommendationType = "Alarm"
	RenderRecommendationTypeSop   RenderRecommendationType = "Sop"
	RenderRecommendationTypeTest  RenderRecommendationType = "Test"
)

Enum values for RenderRecommendationType

func (RenderRecommendationType) Values 

func (RenderRecommendationType) Values() []RenderRecommendationType

Values returns all known values for RenderRecommendationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResiliencyPolicy 

type ResiliencyPolicy struct {

	// Date and time when the resiliency policy was created.
	CreationTime *time.Time

	// Specifies a high-level geographical location constraint for where your
	// resilience policy data can be stored.
	DataLocationConstraint DataLocationConstraint

	// Specifies the estimated cost tier of the resiliency policy.
	EstimatedCostTier EstimatedCostTier

	// The resiliency policy.
	Policy map[string]FailurePolicy

	// Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN
	// is: arn: partition :resiliencehub: region : account :resiliency-policy/ policy-id
	// . For more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General
	// Reference guide.
	//
	// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	PolicyArn *string

	// The description for the policy.
	PolicyDescription *string

	// The name of the policy
	PolicyName *string

	// Tags assigned to the resource. A tag is a label that you assign to an Amazon
	// Web Services resource. Each tag consists of a key/value pair.
	Tags map[string]string

	// The tier for this resiliency policy, ranging from the highest severity (
	// MissionCritical ) to lowest ( NonCritical ).
	Tier ResiliencyPolicyTier
	// contains filtered or unexported fields
}

Defines a resiliency policy.

Resilience Hub allows you to provide a value of zero for rtoInSecs and rpoInSecs of your resiliency policy. But, while assessing your application, the lowest possible assessment result is near zero. Hence, if you provide value zero for rtoInSecs and rpoInSecs , the estimated workload RTO and estimated workload RPO result will be near zero and the Compliance status for your application will be set to Policy breached.

type ResiliencyPolicyTier 

type ResiliencyPolicyTier string
const (
	ResiliencyPolicyTierMissionCritical ResiliencyPolicyTier = "MissionCritical"
	ResiliencyPolicyTierCritical        ResiliencyPolicyTier = "Critical"
	ResiliencyPolicyTierImportant       ResiliencyPolicyTier = "Important"
	ResiliencyPolicyTierCoreServices    ResiliencyPolicyTier = "CoreServices"
	ResiliencyPolicyTierNonCritical     ResiliencyPolicyTier = "NonCritical"
	ResiliencyPolicyTierNotApplicable   ResiliencyPolicyTier = "NotApplicable"
)

Enum values for ResiliencyPolicyTier

func (ResiliencyPolicyTier) Values 

func (ResiliencyPolicyTier) Values() []ResiliencyPolicyTier

Values returns all known values for ResiliencyPolicyTier. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResiliencyScore 

type ResiliencyScore struct {

	// The disruption score for a valid key.
	//
	// This member is required.
	DisruptionScore map[string]float64

	// The outage score for a valid key.
	//
	// This member is required.
	Score float64

	// The score generated by Resilience Hub for the scoring component after running
	// an assessment.
	//
	// For example, if the score is 25 points, it indicates the overall score of your
	// application generated by Resilience Hub after running an assessment.
	ComponentScore map[string]ScoringComponentResiliencyScore
	// contains filtered or unexported fields
}

The overall resiliency score, returned as an object that includes the disruption score and outage score.

type ResiliencyScoreType 

type ResiliencyScoreType string
const (
	ResiliencyScoreTypeCompliance ResiliencyScoreType = "Compliance"
	ResiliencyScoreTypeTest       ResiliencyScoreType = "Test"
	ResiliencyScoreTypeAlarm      ResiliencyScoreType = "Alarm"
	ResiliencyScoreTypeSop        ResiliencyScoreType = "Sop"
)

Enum values for ResiliencyScoreType

func (ResiliencyScoreType) Values 

func (ResiliencyScoreType) Values() []ResiliencyScoreType

Values returns all known values for ResiliencyScoreType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceDrift 

type ResourceDrift struct {

	// Amazon Resource Name (ARN) of the application whose resources have drifted. The
	// format for this ARN is: arn: partition :resiliencehub: region : account
	// :app-assessment/ app-id . For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon
	// Web Services General Reference guide.
	//
	// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	AppArn *string

	// Version of the application whose resources have drifted.
	AppVersion *string

	// Indicates if the resource was added or removed.
	DiffType DifferenceType

	// Reference identifier of the resource drift.
	ReferenceId *string

	// Identifier of the drifted resource.
	ResourceIdentifier *ResourceIdentifier
	// contains filtered or unexported fields
}

Indicates the resources that have drifted in the current application version.

type ResourceError 

type ResourceError struct {

	// Identifier of the logical resource.
	LogicalResourceId *string

	// Identifier of the physical resource.
	PhysicalResourceId *string

	//  This is the error message.
	Reason *string
	// contains filtered or unexported fields
}

Defines application resource errors.

type ResourceErrorsDetails 

type ResourceErrorsDetails struct {

	//  This indicates if there are more errors not listed in the resourceErrors list.
	HasMoreErrors *bool

	//  A list of errors retrieving an application's resources.
	ResourceErrors []ResourceError
	// contains filtered or unexported fields
}

A list of errors retrieving an application's resources.

type ResourceIdentifier 

type ResourceIdentifier struct {

	// Logical identifier of the drifted resource.
	LogicalResourceId *LogicalResourceId

	// Type of the drifted resource.
	ResourceType *string
	// contains filtered or unexported fields
}

Defines a resource identifier for the drifted resource.

type ResourceImportStatusType 

type ResourceImportStatusType string
const (
	ResourceImportStatusTypePending    ResourceImportStatusType = "Pending"
	ResourceImportStatusTypeInProgress ResourceImportStatusType = "InProgress"
	ResourceImportStatusTypeFailed     ResourceImportStatusType = "Failed"
	ResourceImportStatusTypeSuccess    ResourceImportStatusType = "Success"
)

Enum values for ResourceImportStatusType

func (ResourceImportStatusType) Values 

func (ResourceImportStatusType) Values() []ResourceImportStatusType

Values returns all known values for ResourceImportStatusType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceImportStrategyType 

type ResourceImportStrategyType string
const (
	ResourceImportStrategyTypeAddOnly    ResourceImportStrategyType = "AddOnly"
	ResourceImportStrategyTypeReplaceAll ResourceImportStrategyType = "ReplaceAll"
)

Enum values for ResourceImportStrategyType

func (ResourceImportStrategyType) Values 

func (ResourceImportStrategyType) Values() []ResourceImportStrategyType

Values returns all known values for ResourceImportStrategyType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceMapping 

type ResourceMapping struct {

	// Specifies the type of resource mapping.
	//
	// This member is required.
	MappingType ResourceMappingType

	// Identifier of the physical resource.
	//
	// This member is required.
	PhysicalResourceId *PhysicalResourceId

	// Name of the application this resource is mapped to when the mappingType is
	// AppRegistryApp .
	AppRegistryAppName *string

	// Name of the Amazon Elastic Kubernetes Service cluster and namespace that this
	// resource is mapped to when the mappingType is EKS .
	//
	// This parameter accepts values in "eks-cluster/namespace" format.
	EksSourceName *string

	// Name of the CloudFormation stack this resource is mapped to when the mappingType
	// is CfnStack .
	LogicalStackName *string

	// Name of the Resource Groups that this resource is mapped to when the mappingType
	// is ResourceGroup .
	ResourceGroupName *string

	// Name of the resource that this resource is mapped to when the mappingType is
	// Resource .
	ResourceName *string

	// Name of the Terraform source that this resource is mapped to when the
	// mappingType is Terraform .
	TerraformSourceName *string
	// contains filtered or unexported fields
}

Defines a resource mapping.

type ResourceMappingType 

type ResourceMappingType string
const (
	ResourceMappingTypeCfnStack       ResourceMappingType = "CfnStack"
	ResourceMappingTypeResource       ResourceMappingType = "Resource"
	ResourceMappingTypeAppRegistryApp ResourceMappingType = "AppRegistryApp"
	ResourceMappingTypeResourceGroup  ResourceMappingType = "ResourceGroup"
	ResourceMappingTypeTerraform      ResourceMappingType = "Terraform"
	ResourceMappingTypeEks            ResourceMappingType = "EKS"
)

Enum values for ResourceMappingType

func (ResourceMappingType) Values 

func (ResourceMappingType) Values() []ResourceMappingType

Values returns all known values for ResourceMappingType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

This exception occurs when the specified resource could not be found.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourceResolutionStatusType 

type ResourceResolutionStatusType string
const (
	ResourceResolutionStatusTypePending    ResourceResolutionStatusType = "Pending"
	ResourceResolutionStatusTypeInProgress ResourceResolutionStatusType = "InProgress"
	ResourceResolutionStatusTypeFailed     ResourceResolutionStatusType = "Failed"
	ResourceResolutionStatusTypeSuccess    ResourceResolutionStatusType = "Success"
)

Enum values for ResourceResolutionStatusType

func (ResourceResolutionStatusType) Values 

func (ResourceResolutionStatusType) Values() []ResourceResolutionStatusType

Values returns all known values for ResourceResolutionStatusType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceSourceType 

type ResourceSourceType string
const (
	ResourceSourceTypeAppTemplate ResourceSourceType = "AppTemplate"
	ResourceSourceTypeDiscovered  ResourceSourceType = "Discovered"
)

Enum values for ResourceSourceType

func (ResourceSourceType) Values 

func (ResourceSourceType) Values() []ResourceSourceType

Values returns all known values for ResourceSourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type S3Location 

type S3Location struct {

	// The name of the Amazon S3 bucket.
	Bucket *string

	// The prefix for the Amazon S3 bucket.
	Prefix *string
	// contains filtered or unexported fields
}

The location of the Amazon S3 bucket.

type ScoringComponentResiliencyScore 

type ScoringComponentResiliencyScore struct {

	// Number of recommendations that were excluded from the assessment.
	//
	// For example, if the excludedCount for Alarms coverage scoring component is 7,
	// it indicates that 7 Amazon CloudWatch alarms are excluded from the assessment.
	ExcludedCount int64

	// Number of recommendations that must be implemented to obtain the maximum
	// possible score for the scoring component. For SOPs, alarms, and tests, these are
	// the number of recommendations that must be implemented. For compliance, these
	// are the number of Application Components that have breached the resiliency
	// policy.
	//
	// For example, if the outstandingCount for Alarms coverage scoring component is
	// 5, it indicates that 5 Amazon CloudWatch alarms need to be implemented to
	// achieve the maximum possible score.
	OutstandingCount int64

	// Maximum possible score that can be obtained for the scoring component.
	//
	// For example, if the possibleScore is 20 points, it indicates the maximum
	// possible score you can achieve for the scoring component when you run a new
	// assessment after implementing all the Resilience Hub recommendations.
	PossibleScore float64

	// Resiliency score points given for the scoring component. The score is always
	// less than or equal to the possibleScore .
	Score float64
	// contains filtered or unexported fields
}

Resiliency score of each scoring component. For more information about scoring component, see Calculating resiliency score.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

This exception occurs when you have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type SopRecommendation 

type SopRecommendation struct {

	// Identifier for the SOP recommendation.
	//
	// This member is required.
	RecommendationId *string

	// Reference identifier for the SOP recommendation.
	//
	// This member is required.
	ReferenceId *string

	// The service type.
	//
	// This member is required.
	ServiceType SopServiceType

	// Name of the Application Component.
	AppComponentName *string

	// Description of the SOP recommendation.
	Description *string

	// The recommendation items.
	Items []RecommendationItem

	// Name of the SOP recommendation.
	Name *string

	// Prerequisite for the SOP recommendation.
	Prerequisite *string

	// Status of the recommended standard operating procedure.
	RecommendationStatus RecommendationStatus
	// contains filtered or unexported fields
}

Defines a standard operating procedure (SOP) recommendation.

type SopServiceType 

type SopServiceType string
const (
	SopServiceTypeSsm SopServiceType = "SSM"
)

Enum values for SopServiceType

func (SopServiceType) Values 

func (SopServiceType) Values() []SopServiceType

Values returns all known values for SopServiceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TemplateFormat 

type TemplateFormat string
const (
	TemplateFormatCfnYaml TemplateFormat = "CfnYaml"
	TemplateFormatCfnJson TemplateFormat = "CfnJson"
)

Enum values for TemplateFormat

func (TemplateFormat) Values 

func (TemplateFormat) Values() []TemplateFormat

Values returns all known values for TemplateFormat. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TerraformSource 

type TerraformSource struct {

	//  The URL of the Terraform s3 state file you need to import.
	//
	// This member is required.
	S3StateFileUrl *string
	// contains filtered or unexported fields
}

The Terraform s3 state file you need to import.

type TestRecommendation 

type TestRecommendation struct {

	// Reference identifier for the test recommendation.
	//
	// This member is required.
	ReferenceId *string

	// Name of the Application Component.
	AppComponentName *string

	//  A list of recommended alarms that are used in the test and must be exported
	// before or with the test.
	DependsOnAlarms []string

	// Description for the test recommendation.
	Description *string

	// Intent of the test recommendation.
	Intent *string

	// The test recommendation items.
	Items []RecommendationItem

	// Name of the test recommendation.
	Name *string

	// Prerequisite of the test recommendation.
	Prerequisite *string

	// Identifier for the test recommendation.
	RecommendationId *string

	// Status of the recommended test.
	RecommendationStatus RecommendationStatus

	// Level of risk for this test recommendation.
	Risk TestRisk

	// Type of test recommendation.
	Type TestType
	// contains filtered or unexported fields
}

Defines a test recommendation.

type TestRisk 

type TestRisk string
const (
	TestRiskSmall  TestRisk = "Small"
	TestRiskMedium TestRisk = "Medium"
	TestRiskHigh   TestRisk = "High"
)

Enum values for TestRisk

func (TestRisk) Values 

func (TestRisk) Values() []TestRisk

Values returns all known values for TestRisk. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TestType 

type TestType string
const (
	TestTypeSoftware TestType = "Software"
	TestTypeHardware TestType = "Hardware"
	TestTypeAz       TestType = "AZ"
	TestTypeRegion   TestType = "Region"
)

Enum values for TestType

func (TestType) Values 

func (TestType) Values() []TestType

Values returns all known values for TestType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	RetryAfterSeconds *int32
	// contains filtered or unexported fields
}

This exception occurs when you have exceeded the limit on the number of requests per second.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type UnsupportedResource 

type UnsupportedResource struct {

	// Logical resource identifier for the unsupported resource.
	//
	// This member is required.
	LogicalResourceId *LogicalResourceId

	// Physical resource identifier for the unsupported resource.
	//
	// This member is required.
	PhysicalResourceId *PhysicalResourceId

	// The type of resource.
	//
	// This member is required.
	ResourceType *string

	// The status of the unsupported resource.
	UnsupportedResourceStatus *string
	// contains filtered or unexported fields
}

Defines a resource that is not supported by Resilience Hub.

type UpdateRecommendationStatusItem 

type UpdateRecommendationStatusItem struct {

	// Resource identifier of the operational recommendation item.
	ResourceId *string

	// Identifier of the target Amazon Web Services account.
	TargetAccountId *string

	// Identifier of the target Amazon Web Services Region.
	TargetRegion *string
	// contains filtered or unexported fields
}

Defines the operational recommendation item that needs a status update.

type UpdateRecommendationStatusRequestEntry 

type UpdateRecommendationStatusRequestEntry struct {

	// An identifier for an entry in this batch that is used to communicate the result.
	//
	// The entryId s of a batch request need to be unique within a request.
	//
	// This member is required.
	EntryId *string

	// Indicates if the operational recommendation needs to be excluded. If set to
	// True, the operational recommendation will be excluded.
	//
	// This member is required.
	Excluded *bool

	// The operational recommendation item.
	//
	// This member is required.
	Item *UpdateRecommendationStatusItem

	// Reference identifier of the operational recommendation item.
	//
	// This member is required.
	ReferenceId *string

	// Indicates the reason for excluding an operational recommendation.
	ExcludeReason ExcludeRecommendationReason
	// contains filtered or unexported fields
}

Defines the operational recommendation item that is to be included or excluded.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

This exception occurs when a request is not valid.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.