ssm

package
v0.0.96 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AutomationDocument_ARN_FORMAT 

func AutomationDocument_ARN_FORMAT() awscdk.ArnFormat

func AutomationDocument_IsConstruct 

func AutomationDocument_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 AutomationDocument_IsOwnedResource 

func AutomationDocument_IsOwnedResource(construct constructs.IConstruct) *bool

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

func AutomationDocument_IsResource 

func AutomationDocument_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

func DocumentBase_ARN_FORMAT 

func DocumentBase_ARN_FORMAT() awscdk.ArnFormat

func DocumentBase_IsConstruct 

func DocumentBase_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 DocumentBase_IsOwnedResource 

func DocumentBase_IsOwnedResource(construct constructs.IConstruct) *bool

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

func DocumentBase_IsResource 

func DocumentBase_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

func Document_ARN_FORMAT 

func Document_ARN_FORMAT() awscdk.ArnFormat

func Document_IsConstruct 

func Document_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 Document_IsOwnedResource 

func Document_IsOwnedResource(construct constructs.IConstruct) *bool

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

func Document_IsResource 

func Document_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

func NewDocumentBase_Override 

func NewDocumentBase_Override(d DocumentBase, scope constructs.IConstruct, id *string, props *DocumentBaseProps)

func NewDocumentContent_Override 

func NewDocumentContent_Override(d DocumentContent)

func NewDocument_Override 

func NewDocument_Override(d Document, scope constructs.IConstruct, id *string, props *DocumentProps)

Types

type AutomationDocument 

type AutomationDocument interface {
	DocumentBase
	IAutomationDocument
	AutomationDefinitionArn() *string
	Content() IDocumentContent
	DocumentArn() *string
	DocumentName() *string
	DocumentType() DocumentType
	// 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
	Name() *string
	// 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
	Requires() *[]*DocumentRequirement
	Resource() awsssm.CfnDocument
	// The stack in which this resource is defined.
	Stack() awscdk.Stack
	TargetType() *string
	UpdateMethod() DocumentUpdateMethod
	VersionName() *string
	AddRequirement(requirement *DocumentRequirement) IDocument
	// 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)
	ArnForAutomationDefinitionVersion(version *string) *string
	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
	// Returns a string representation of this construct.
	ToString() *string
	Validate() *[]*string
}

type AutomationSchemaVersion 

type AutomationSchemaVersion interface {
	Version() *string
}

func AutomationDocument_DEFAULT_SCHEMA_VERSION 

func AutomationDocument_DEFAULT_SCHEMA_VERSION() AutomationSchemaVersion

func AutomationSchemaVersion_Of 

func AutomationSchemaVersion_Of(version *string) AutomationSchemaVersion

func AutomationSchemaVersion_VER_0_3 

func AutomationSchemaVersion_VER_0_3() AutomationSchemaVersion

type Document 

type Document interface {
	DocumentBase
	Content() IDocumentContent
	DocumentArn() *string
	DocumentName() *string
	DocumentType() DocumentType
	// 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
	Name() *string
	// 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
	Requires() *[]*DocumentRequirement
	Resource() awsssm.CfnDocument
	// The stack in which this resource is defined.
	Stack() awscdk.Stack
	TargetType() *string
	UpdateMethod() DocumentUpdateMethod
	VersionName() *string
	AddRequirement(requirement *DocumentRequirement) IDocument
	// 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
	// Returns a string representation of this construct.
	ToString() *string
	Validate() *[]*string
}

func NewDocument 

func NewDocument(scope constructs.IConstruct, id *string, props *DocumentProps) Document

type DocumentBase 

type DocumentBase interface {
	awscdk.Resource
	IDocument
	Content() IDocumentContent
	DocumentArn() *string
	DocumentName() *string
	DocumentType() DocumentType
	// 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
	Name() *string
	// 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
	Requires() *[]*DocumentRequirement
	Resource() awsssm.CfnDocument
	// The stack in which this resource is defined.
	Stack() awscdk.Stack
	TargetType() *string
	UpdateMethod() DocumentUpdateMethod
	VersionName() *string
	AddRequirement(requirement *DocumentRequirement) IDocument
	// 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
	// Returns a string representation of this construct.
	ToString() *string
	Validate() *[]*string
}

func NewDocumentBase 

func NewDocumentBase(scope constructs.IConstruct, id *string, props *DocumentBaseProps) DocumentBase

type DocumentBaseProps 

type DocumentBaseProps 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"`
	Content      IDocumentContent        `field:"required" json:"content" yaml:"content"`
	DocumentType DocumentType            `field:"optional" json:"documentType" yaml:"documentType"`
	Name         *string                 `field:"optional" json:"name" yaml:"name"`
	Requires     *[]*DocumentRequirement `field:"optional" json:"requires" yaml:"requires"`
	TargetType   *string                 `field:"optional" json:"targetType" yaml:"targetType"`
	UpdateMethod DocumentUpdateMethod    `field:"optional" json:"updateMethod" yaml:"updateMethod"`
	VersionName  *string                 `field:"optional" json:"versionName" yaml:"versionName"`
}

type DocumentContent 

type DocumentContent interface {
}

func NewDocumentContent 

func NewDocumentContent() DocumentContent

type DocumentContentResult 

type DocumentContentResult struct {
	Content        *string        `field:"required" json:"content" yaml:"content"`
	DocumentFormat DocumentFormat `field:"required" json:"documentFormat" yaml:"documentFormat"`
}

type DocumentFormat 

type DocumentFormat interface {
	Value() *string
}

func DocumentFormat_JSON 

func DocumentFormat_JSON() DocumentFormat

func DocumentFormat_Of 

func DocumentFormat_Of(value *string) DocumentFormat

func DocumentFormat_TEXT 

func DocumentFormat_TEXT() DocumentFormat

func DocumentFormat_YAML 

func DocumentFormat_YAML() DocumentFormat

type DocumentProps 

type DocumentProps 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"`
	Content      IDocumentContent        `field:"required" json:"content" yaml:"content"`
	DocumentType DocumentType            `field:"optional" json:"documentType" yaml:"documentType"`
	Name         *string                 `field:"optional" json:"name" yaml:"name"`
	Requires     *[]*DocumentRequirement `field:"optional" json:"requires" yaml:"requires"`
	TargetType   *string                 `field:"optional" json:"targetType" yaml:"targetType"`
	UpdateMethod DocumentUpdateMethod    `field:"optional" json:"updateMethod" yaml:"updateMethod"`
	VersionName  *string                 `field:"optional" json:"versionName" yaml:"versionName"`
}

type DocumentRequirement 

type DocumentRequirement struct {
	Document IDocument `field:"required" json:"document" yaml:"document"`
	Version  *string   `field:"optional" json:"version" yaml:"version"`
}

type DocumentType 

type DocumentType interface {
	Name() *string
}

func DocumentType_APPLICATION_CONFIGURATION 

func DocumentType_APPLICATION_CONFIGURATION() DocumentType

func DocumentType_APPLICATION_CONFIGURATION_SCHEMA 

func DocumentType_APPLICATION_CONFIGURATION_SCHEMA() DocumentType

func DocumentType_AUTOMATION 

func DocumentType_AUTOMATION() DocumentType

func DocumentType_AUTOMATION_CHANGE_TEMPLATE 

func DocumentType_AUTOMATION_CHANGE_TEMPLATE() DocumentType

func DocumentType_COMMAND 

func DocumentType_COMMAND() DocumentType

func DocumentType_DEPLOYMENT_STRATEGY 

func DocumentType_DEPLOYMENT_STRATEGY() DocumentType

func DocumentType_Of 

func DocumentType_Of(value *string) DocumentType

func DocumentType_PACKAGE 

func DocumentType_PACKAGE() DocumentType

func DocumentType_POLICY 

func DocumentType_POLICY() DocumentType

func DocumentType_SESSION 

func DocumentType_SESSION() DocumentType

type DocumentUpdateMethod 

type DocumentUpdateMethod interface {
	Value() *string
}

func DocumentUpdateMethod_NEW_VERSION 

func DocumentUpdateMethod_NEW_VERSION() DocumentUpdateMethod

func DocumentUpdateMethod_Of 

func DocumentUpdateMethod_Of(value *string) DocumentUpdateMethod

func DocumentUpdateMethod_REPLACE 

func DocumentUpdateMethod_REPLACE() DocumentUpdateMethod

type IAutomationDocument 

type IAutomationDocument interface {
	IDocument
	ArnForAutomationDefinitionVersion(version *string) *string
	AutomationDefinitionArn() *string
}

func AutomationDocument_FromManaged 

func AutomationDocument_FromManaged(scope constructs.IConstruct, id *string, managedDocumentName *string) IAutomationDocument

type IDocument 

type IDocument interface {
	awscdk.IResource
	DocumentArn() *string
	DocumentName() *string
}

type IDocumentContent 

type IDocumentContent interface {
	Bind(scope constructs.IConstruct) *DocumentContentResult
}

func DocumentContent_FromObject 

func DocumentContent_FromObject(props *ObjectContentProps) IDocumentContent

func DocumentContent_FromString 

func DocumentContent_FromString(props *StringContentProps) IDocumentContent

type ObjectContentProps 

type ObjectContentProps struct {
	Input *map[string]interface{} `field:"required" json:"input" yaml:"input"`
}

type StringContentProps 

type StringContentProps struct {
	Content        *string        `field:"required" json:"content" yaml:"content"`
	DocumentFormat DocumentFormat `field:"required" json:"documentFormat" yaml:"documentFormat"`
}

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.