config

package
v0.0.94 Latest Latest
Warning

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

 Go to latest Published: Nov 14, 2023 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewRemediationConfiguration_Override 

func NewRemediationConfiguration_Override(r RemediationConfiguration, scope constructs.IConstruct, id *string, props *RemediationConfigurationProps)

func NewRemediationTarget_Override 

func NewRemediationTarget_Override(r RemediationTarget)

func RemediationConfiguration_ARN_FORMAT 

func RemediationConfiguration_ARN_FORMAT() awscdk.ArnFormat

func RemediationConfiguration_IsConstruct 

func RemediationConfiguration_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.

func RemediationConfiguration_IsOwnedResource 

func RemediationConfiguration_IsOwnedResource(construct constructs.IConstruct) *bool

Returns true if the construct was created by CDK, and false otherwise.

func RemediationConfiguration_IsResource 

func RemediationConfiguration_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

Types

type AutomationDocumentRemediationProps 

type AutomationDocumentRemediationProps struct {
	Document              ssm.IAutomationDocument `field:"required" json:"document" yaml:"document"`
	ConcurrencyPercentage *float64                `field:"optional" json:"concurrencyPercentage" yaml:"concurrencyPercentage"`
	ErrorPercentage       *float64                `field:"optional" json:"errorPercentage" yaml:"errorPercentage"`
	Version               *string                 `field:"optional" json:"version" yaml:"version"`
}

type IRemediationConfiguration 

type IRemediationConfiguration interface {
	RemediationConfigurationArn() *string
	RemediationConfigurationName() *string
}

func RemediationConfiguration_FromRemediationConfigurationArn 

func RemediationConfiguration_FromRemediationConfigurationArn(scope constructs.IConstruct, id *string, arn *string) IRemediationConfiguration

func RemediationConfiguration_FromRemediationConfigurationAttributes 

func RemediationConfiguration_FromRemediationConfigurationAttributes(scope constructs.IConstruct, id *string, attrs *RemediationConfigurationAttributes) IRemediationConfiguration

func RemediationConfiguration_FromRemediationConfigurationName 

func RemediationConfiguration_FromRemediationConfigurationName(scope constructs.IConstruct, id *string, name *string) IRemediationConfiguration

type IRemediationTarget 

type IRemediationTarget interface {
	Bind(scope constructs.IConstruct) *RemediationTargetConfiguration
}

func RemediationTarget_AutomationDocument 

func RemediationTarget_AutomationDocument(props *AutomationDocumentRemediationProps) IRemediationTarget

type RemediationConfiguration 

type RemediationConfiguration interface {
	awscdk.Resource
	IRemediationConfiguration
	Automatic() *bool
	ConfigRule() awsconfig.IRule
	// The environment this resource belongs to.
	//
	// For resources that are created and managed by the CDK
	// (generally, those created by creating new class instances like Role, Bucket, etc.),
	// this is always the same as the environment of the stack they belong to;
	// however, for imported resources
	// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
	// that might be different than the stack they were imported into.
	Env() *awscdk.ResourceEnvironment
	MaximumAutomaticAttempts() *float64
	// The tree node.
	Node() constructs.Node
	// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by CloudFormation
	// - a concrete name generated automatically during synthesis, in
	//   cross-environment scenarios.
	PhysicalName() *string
	RemediationConfigurationArn() *string
	RemediationConfigurationName() *string
	Resource() awsconfig.CfnRemediationConfiguration
	ResourceType() *string
	RetryInterval() awscdk.Duration
	// The stack in which this resource is defined.
	Stack() awscdk.Stack
	AddParameter(key *string, values ...*string)
	// Apply the given removal policy to this resource.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
	//
	// Normally, this token will resolve to `arnAttr`, but if the resource is
	// referenced across environments, `arnComponents` will be used to synthesize
	// a concrete ARN with the resource's physical name. Make sure to reference
	// `this.physicalName` in `arnComponents`.
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
	//
	// Normally, this token will resolve to `nameAttr`, but if the resource is
	// referenced across environments, it will be resolved to `this.physicalName`,
	// which will be a concrete name.
	GetResourceNameAttribute(nameAttr *string) *string
	RenderParameters() interface{}
	// Returns a string representation of this construct.
	ToString() *string
}

func NewRemediationConfiguration 

func NewRemediationConfiguration(scope constructs.IConstruct, id *string, props *RemediationConfigurationProps) RemediationConfiguration

type RemediationConfigurationAttributes 

type RemediationConfigurationAttributes struct {
	Arn  *string `field:"optional" json:"arn" yaml:"arn"`
	Name *string `field:"optional" json:"name" yaml:"name"`
}

type RemediationConfigurationProps 

type RemediationConfigurationProps struct {
	// The AWS account ID this resource belongs to.
	// Default: - the resource is in the same account as the stack it belongs to.
	//
	Account *string `field:"optional" json:"account" yaml:"account"`
	// ARN to deduce region and account from.
	//
	// The ARN is parsed and the account and region are taken from the ARN.
	// This should be used for imported resources.
	//
	// Cannot be supplied together with either `account` or `region`.
	// Default: - take environment from `account`, `region` parameters, or use Stack environment.
	//
	EnvironmentFromArn *string `field:"optional" json:"environmentFromArn" yaml:"environmentFromArn"`
	// The value passed in by users to the physical name prop of the resource.
	//
	// - `undefined` implies that a physical name will be allocated by
	//   CloudFormation during deployment.
	// - a concrete value implies a specific physical name
	// - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated
	//   by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
	// Default: - The physical name will be allocated by CloudFormation at deployment time.
	//
	PhysicalName *string `field:"optional" json:"physicalName" yaml:"physicalName"`
	// The AWS region this resource belongs to.
	// Default: - the resource is in the same region as the stack it belongs to.
	//
	Region                   *string                    `field:"optional" json:"region" yaml:"region"`
	ConfigRule               awsconfig.IRule            `field:"required" json:"configRule" yaml:"configRule"`
	StaticParameters         *map[string]*[]interface{} `field:"required" json:"staticParameters" yaml:"staticParameters"`
	Target                   IRemediationTarget         `field:"required" json:"target" yaml:"target"`
	Automatic                *bool                      `field:"optional" json:"automatic" yaml:"automatic"`
	MaximumAutomaticAttempts *float64                   `field:"optional" json:"maximumAutomaticAttempts" yaml:"maximumAutomaticAttempts"`
	ResourceParameter        *string                    `field:"optional" json:"resourceParameter" yaml:"resourceParameter"`
	ResourceType             *string                    `field:"optional" json:"resourceType" yaml:"resourceType"`
	RetryInterval            awscdk.Duration            `field:"optional" json:"retryInterval" yaml:"retryInterval"`
}

type RemediationTarget 

type RemediationTarget interface {
}

func NewRemediationTarget 

func NewRemediationTarget() RemediationTarget

type RemediationTargetConfiguration 

type RemediationTargetConfiguration struct {
	TargetId      *string                                                          `field:"required" json:"targetId" yaml:"targetId"`
	TargetType    RemediationTargetType                                            `field:"required" json:"targetType" yaml:"targetType"`
	Controls      *awsconfig.CfnRemediationConfiguration_ExecutionControlsProperty `field:"optional" json:"controls" yaml:"controls"`
	TargetVersion *string                                                          `field:"optional" json:"targetVersion" yaml:"targetVersion"`
}

type RemediationTargetType 

type RemediationTargetType interface {
	Value() *string
}

func RemediationTargetType_Of 

func RemediationTargetType_Of(value *string) RemediationTargetType

func RemediationTargetType_SSM_DOCUMENT 

func RemediationTargetType_SSM_DOCUMENT() RemediationTargetType

Source Files

View all Source files

Directories

Path Synopsis

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.