awsssmquicksetup

package
v2.159.0 Latest Latest
Warning

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

 Go to latest Published: Sep 19, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

README

AWS::SSMQuickSetup Construct Library

---

All classes with the Cfn prefix in this module (CFN Resources) are always stable and safe to use.

This module is part of the AWS Cloud Development Kit project.

import ssmquicksetup "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::SSMQuickSetup.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnConfigurationManager_CFN_RESOURCE_TYPE_NAME 

func CfnConfigurationManager_CFN_RESOURCE_TYPE_NAME() *string

func CfnConfigurationManager_IsCfnElement 

func CfnConfigurationManager_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnConfigurationManager_IsCfnResource 

func CfnConfigurationManager_IsCfnResource(x interface{}) *bool

Check whether the given object is a CfnResource.

func CfnConfigurationManager_IsConstruct 

func CfnConfigurationManager_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

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

func NewCfnConfigurationManager_Override 

func NewCfnConfigurationManager_Override(c CfnConfigurationManager, scope constructs.Construct, id *string, props *CfnConfigurationManagerProps)

Types

type CfnConfigurationManager 

type CfnConfigurationManager interface {
	awscdk.CfnResource
	awscdk.IInspectable
	awscdk.ITaggableV2
	// The datetime stamp when the configuration manager was created.
	AttrCreatedAt() *string
	// The datetime stamp when the configuration manager was last updated.
	AttrLastModifiedAt() *string
	// The ARN of the Quick Setup configuration.
	AttrManagerArn() *string
	// Summaries of the state of the configuration manager.
	//
	// These summaries include an aggregate of the statuses from the configuration definition associated with the configuration manager. This includes deployment statuses, association statuses, drift statuses, health checks, and more.
	AttrStatusSummaries() awscdk.IResolvable
	// Tag Manager which manages the tags for this resource.
	CdkTagManager() awscdk.TagManager
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// The definition of the Quick Setup configuration that the configuration manager deploys.
	ConfigurationDefinitions() interface{}
	SetConfigurationDefinitions(val interface{})
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	// The description of the configuration.
	Description() *string
	SetDescription(val *string)
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The name of the configuration.
	Name() *string
	SetName(val *string)
	// The tree node.
	Node() constructs.Node
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// Key-value pairs of metadata to assign to the configuration manager.
	Tags() *map[string]*string
	SetTags(val *map[string]*string)
	// Deprecated.
	// Deprecated: use `updatedProperties`
	//
	// Return properties modified after initiation
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperties() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependency(target awscdk.CfnResource)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	// Deprecated: use addDependency.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//   "GlobalSecondaryIndexes": [
	//     {
	//       "Projection": {
	//         "NonKeyAttributes": [ "myattribute" ]
	//         ...
	//       }
	//       ...
	//     },
	//     {
	//       "ProjectionType": "INCLUDE"
	//       ...
	//     },
	//   ]
	//   ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// 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`). In some
	// cases, a snapshot can be taken of the resource prior to deletion
	// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
	// can be found in the following link:.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
	//
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Retrieves an array of resources this resource depends on.
	//
	// This assembles dependencies on resources across stacks (including nested stacks)
	// automatically.
	ObtainDependencies() *[]interface{}
	// Get a shallow copy of dependencies between this resource and other resources in the same stack.
	ObtainResourceDependencies() *[]awscdk.CfnResource
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Indicates that this resource no longer depends on another resource.
	//
	// This can be used for resources across stacks (including nested stacks)
	// and the dependency will automatically be removed from the relevant scope.
	RemoveDependency(target awscdk.CfnResource)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Replaces one dependency with another.
	ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	ValidateProperties(_properties interface{})
}

Creates a Quick Setup configuration manager resource.

This object is a collection of desired state configurations for multiple configuration definitions and summaries describing the deployments of those definitions.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnConfigurationManager := awscdk.Aws_ssmquicksetup.NewCfnConfigurationManager(this, jsii.String("MyCfnConfigurationManager"), &CfnConfigurationManagerProps{
	ConfigurationDefinitions: []interface{}{
		&ConfigurationDefinitionProperty{
			Parameters: map[string]*string{
				"parametersKey": jsii.String("parameters"),
			},
			Type: jsii.String("type"),

			// the properties below are optional
			Id: jsii.String("id"),
			LocalDeploymentAdministrationRoleArn: jsii.String("localDeploymentAdministrationRoleArn"),
			LocalDeploymentExecutionRoleName: jsii.String("localDeploymentExecutionRoleName"),
			TypeVersion: jsii.String("typeVersion"),
		},
	},

	// the properties below are optional
	Description: jsii.String("description"),
	Name: jsii.String("name"),
	Tags: map[string]*string{
		"tagsKey": jsii.String("tags"),
	},
})

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-configurationmanager.html

func NewCfnConfigurationManager 

func NewCfnConfigurationManager(scope constructs.Construct, id *string, props *CfnConfigurationManagerProps) CfnConfigurationManager

type CfnConfigurationManagerProps 

type CfnConfigurationManagerProps struct {
	// The definition of the Quick Setup configuration that the configuration manager deploys.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-configurationmanager.html#cfn-ssmquicksetup-configurationmanager-configurationdefinitions
	//
	ConfigurationDefinitions interface{} `field:"required" json:"configurationDefinitions" yaml:"configurationDefinitions"`
	// The description of the configuration.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-configurationmanager.html#cfn-ssmquicksetup-configurationmanager-description
	//
	Description *string `field:"optional" json:"description" yaml:"description"`
	// The name of the configuration.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-configurationmanager.html#cfn-ssmquicksetup-configurationmanager-name
	//
	Name *string `field:"optional" json:"name" yaml:"name"`
	// Key-value pairs of metadata to assign to the configuration manager.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-configurationmanager.html#cfn-ssmquicksetup-configurationmanager-tags
	//
	Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `CfnConfigurationManager`.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnConfigurationManagerProps := &CfnConfigurationManagerProps{
	ConfigurationDefinitions: []interface{}{
		&ConfigurationDefinitionProperty{
			Parameters: map[string]*string{
				"parametersKey": jsii.String("parameters"),
			},
			Type: jsii.String("type"),

			// the properties below are optional
			Id: jsii.String("id"),
			LocalDeploymentAdministrationRoleArn: jsii.String("localDeploymentAdministrationRoleArn"),
			LocalDeploymentExecutionRoleName: jsii.String("localDeploymentExecutionRoleName"),
			TypeVersion: jsii.String("typeVersion"),
		},
	},

	// the properties below are optional
	Description: jsii.String("description"),
	Name: jsii.String("name"),
	Tags: map[string]*string{
		"tagsKey": jsii.String("tags"),
	},
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmquicksetup-configurationmanager.html

type CfnConfigurationManager_ConfigurationDefinitionProperty 

type CfnConfigurationManager_ConfigurationDefinitionProperty struct {
	// The parameters for the configuration definition type.
	//
	// Parameters for configuration definitions vary based the configuration type. The following tables outline the parameters for each configuration type.
	//
	// - **OpsCenter (Type: AWS QuickSetupType-SSMOpsCenter)** - - `DelegatedAccountId`
	//
	// - Description: (Required) The ID of the delegated administrator account.
	// - `TargetOrganizationalUnits`
	//
	// - Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
	// - `TargetRegions`
	//
	// - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.
	// - **Resource Scheduler (Type: AWS QuickSetupType-Scheduler)** - - `TargetTagKey`
	//
	// - Description: (Required) The tag key assigned to the instances you want to target.
	// - `TargetTagValue`
	//
	// - Description: (Required) The value of the tag key assigned to the instances you want to target.
	// - `ICalendarString`
	//
	// - Description: (Required) An iCalendar formatted string containing the schedule you want Change Manager to use.
	// - `TargetAccounts`
	//
	// - Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either `TargetAccounts` or `TargetOrganizationalUnits` .
	// - `TargetOrganizationalUnits`
	//
	// - Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
	// - `TargetRegions`
	//
	// - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.
	// - **Default Host Management Configuration (Type: AWS QuickSetupType-DHMC)** - - `UpdateSSMAgent`
	//
	// - Description: (Optional) A boolean value that determines whether the SSM Agent is updated on the target instances every 2 weeks. The default value is " `true` ".
	// - `TargetOrganizationalUnits`
	//
	// - Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
	// - `TargetRegions`
	//
	// - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.
	// - **Resource Explorer (Type: AWS QuickSetupType-ResourceExplorer)** - - `SelectedAggregatorRegion`
	//
	// - Description: (Required) The AWS Region where you want to create the aggregator index.
	// - `ReplaceExistingAggregator`
	//
	// - Description: (Required) A boolean value that determines whether to demote an existing aggregator if it is in a Region that differs from the value you specify for the `SelectedAggregatorRegion` .
	// - `TargetOrganizationalUnits`
	//
	// - Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
	// - `TargetRegions`
	//
	// - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.
	// - **Change Manager (Type: AWS QuickSetupType-SSMChangeMgr)** - - `DelegatedAccountId`
	//
	// - Description: (Required) The ID of the delegated administrator account.
	// - `JobFunction`
	//
	// - Description: (Required) The name for the Change Manager job function.
	// - `PermissionType`
	//
	// - Description: (Optional) Specifies whether you want to use default administrator permissions for the job function role, or provide a custom IAM policy. The valid values are `CustomPermissions` and `AdminPermissions` . The default value for the parameter is `CustomerPermissions` .
	// - `CustomPermissions`
	//
	// - Description: (Optional) A JSON string containing the IAM policy you want your job function to use. You must provide a value for this parameter if you specify `CustomPermissions` for the `PermissionType` parameter.
	// - `TargetOrganizationalUnits`
	//
	// - Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
	// - `TargetRegions`
	//
	// - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.
	// - **DevOps Guru (Type: AWS QuickSetupType-DevOpsGuru)** - - `AnalyseAllResources`
	//
	// - Description: (Optional) A boolean value that determines whether DevOps Guru analyzes all AWS CloudFormation stacks in the account. The default value is " `false` ".
	// - `EnableSnsNotifications`
	//
	// - Description: (Optional) A boolean value that determines whether DevOps Guru sends notifications when an insight is created. The default value is " `true` ".
	// - `EnableSsmOpsItems`
	//
	// - Description: (Optional) A boolean value that determines whether DevOps Guru creates an OpsCenter OpsItem when an insight is created. The default value is " `true` ".
	// - `EnableDriftRemediation`
	//
	// - Description: (Optional) A boolean value that determines whether a drift remediation schedule is used. The default value is " `false` ".
	// - `RemediationSchedule`
	//
	// - Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are `rate(30 days)` , `rate(14 days)` , `rate(1 days)` , and `none` . The default value is " `none` ".
	// - `TargetAccounts`
	//
	// - Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either `TargetAccounts` or `TargetOrganizationalUnits` .
	// - `TargetOrganizationalUnits`
	//
	// - Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
	// - `TargetRegions`
	//
	// - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.
	// - **Conformance Packs (Type: AWS QuickSetupType-CFGCPacks)** - - `DelegatedAccountId`
	//
	// - Description: (Optional) The ID of the delegated administrator account. This parameter is required for Organization deployments.
	// - `RemediationSchedule`
	//
	// - Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are `rate(30 days)` , `rate(14 days)` , `rate(2 days)` , and `none` . The default value is " `none` ".
	// - `CPackNames`
	//
	// - Description: (Required) A comma separated list of AWS Config conformance packs.
	// - `TargetAccounts`
	//
	// - Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either `TargetAccounts` or `TargetOrganizationalUnits` .
	// - `TargetOrganizationalUnits`
	//
	// - Description: (Optional) The ID of the root of your Organization. This configuration type doesn't currently support choosing specific OUs. The configuration will be deployed to all the OUs in the Organization.
	// - `TargetRegions`
	//
	// - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.
	// - **AWS Config Recording (Type: AWS QuickSetupType-CFGRecording)** - - `RecordAllResources`
	//
	// - Description: (Optional) A boolean value that determines whether all supported resources are recorded. The default value is " `true` ".
	// - `ResourceTypesToRecord`
	//
	// - Description: (Optional) A comma separated list of resource types you want to record.
	// - `RecordGlobalResourceTypes`
	//
	// - Description: (Optional) A boolean value that determines whether global resources are recorded with all resource configurations. The default value is " `false` ".
	// - `GlobalResourceTypesRegion`
	//
	// - Description: (Optional) Determines the AWS Region where global resources are recorded.
	// - `UseCustomBucket`
	//
	// - Description: (Optional) A boolean value that determines whether a custom Amazon S3 bucket is used for delivery. The default value is " `false` ".
	// - `DeliveryBucketName`
	//
	// - Description: (Optional) The name of the Amazon S3 bucket you want AWS Config to deliver configuration snapshots and configuration history files to.
	// - `DeliveryBucketPrefix`
	//
	// - Description: (Optional) The key prefix you want to use in the custom Amazon S3 bucket.
	// - `NotificationOptions`
	//
	// - Description: (Optional) Determines the notification configuration for the recorder. The valid values are `NoStreaming` , `UseExistingTopic` , and `CreateTopic` . The default value is `NoStreaming` .
	// - `CustomDeliveryTopicAccountId`
	//
	// - Description: (Optional) The ID of the AWS account where the Amazon SNS topic you want to use for notifications resides. You must specify a value for this parameter if you use the `UseExistingTopic` notification option.
	// - `CustomDeliveryTopicName`
	//
	// - Description: (Optional) The name of the Amazon SNS topic you want to use for notifications. You must specify a value for this parameter if you use the `UseExistingTopic` notification option.
	// - `RemediationSchedule`
	//
	// - Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are `rate(30 days)` , `rate(7 days)` , `rate(1 days)` , and `none` . The default value is " `none` ".
	// - `TargetAccounts`
	//
	// - Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either `TargetAccounts` or `TargetOrganizationalUnits` .
	// - `TargetOrganizationalUnits`
	//
	// - Description: (Optional) The ID of the root of your Organization. This configuration type doesn't currently support choosing specific OUs. The configuration will be deployed to all the OUs in the Organization.
	// - `TargetRegions`
	//
	// - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.
	// - **Host Management (Type: AWS QuickSetupType-SSMHostMgmt)** - - `UpdateSSMAgent`
	//
	// - Description: (Optional) A boolean value that determines whether the SSM Agent is updated on the target instances every 2 weeks. The default value is " `true` ".
	// - `UpdateEc2LaunchAgent`
	//
	// - Description: (Optional) A boolean value that determines whether the EC2 Launch agent is updated on the target instances every month. The default value is " `false` ".
	// - `CollectInventory`
	//
	// - Description: (Optional) A boolean value that determines whether the EC2 Launch agent is updated on the target instances every month. The default value is " `true` ".
	// - `ScanInstances`
	//
	// - Description: (Optional) A boolean value that determines whether the target instances are scanned daily for available patches. The default value is " `true` ".
	// - `InstallCloudWatchAgent`
	//
	// - Description: (Optional) A boolean value that determines whether the Amazon CloudWatch agent is installed on the target instances. The default value is " `false` ".
	// - `UpdateCloudWatchAgent`
	//
	// - Description: (Optional) A boolean value that determines whether the Amazon CloudWatch agent is updated on the target instances every month. The default value is " `false` ".
	// - `IsPolicyAttachAllowed`
	//
	// - Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " `false` ".
	// - `TargetType`
	//
	// - Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are `*` , `InstanceIds` , `ResourceGroups` , and `Tags` . Use `*` to target all instances in the account.
	// - `TargetInstances`
	//
	// - Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify `InstanceIds` for the `TargetType` parameter.
	// - `TargetTagKey`
	//
	// - Description: (Optional) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify `Tags` for the `TargetType` parameter.
	// - `TargetTagValue`
	//
	// - Description: (Optional) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify `Tags` for the `TargetType` parameter.
	// - `ResourceGroupName`
	//
	// - Description: (Optional) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify `ResourceGroups` for the `TargetType` parameter.
	// - `TargetAccounts`
	//
	// - Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either `TargetAccounts` or `TargetOrganizationalUnits` .
	// - `TargetOrganizationalUnits`
	//
	// - Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
	// - `TargetRegions`
	//
	// - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.
	// - **Distributor (Type: AWS QuickSetupType-Distributor)** - - `PackagesToInstall`
	//
	// - Description: (Required) A comma separated list of packages you want to install on the target instances. The valid values are `AWSEFSTools` , `AWSCWAgent` , and `AWSEC2LaunchAgent` .
	// - `RemediationSchedule`
	//
	// - Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are `rate(30 days)` , `rate(14 days)` , `rate(2 days)` , and `none` . The default value is " `rate(30 days)` ".
	// - `IsPolicyAttachAllowed`
	//
	// - Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " `false` ".
	// - `TargetType`
	//
	// - Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are `*` , `InstanceIds` , `ResourceGroups` , and `Tags` . Use `*` to target all instances in the account.
	// - `TargetInstances`
	//
	// - Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify `InstanceIds` for the `TargetType` parameter.
	// - `TargetTagKey`
	//
	// - Description: (Required) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify `Tags` for the `TargetType` parameter.
	// - `TargetTagValue`
	//
	// - Description: (Required) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify `Tags` for the `TargetType` parameter.
	// - `ResourceGroupName`
	//
	// - Description: (Required) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify `ResourceGroups` for the `TargetType` parameter.
	// - `TargetAccounts`
	//
	// - Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either `TargetAccounts` or `TargetOrganizationalUnits` .
	// - `TargetOrganizationalUnits`
	//
	// - Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
	// - `TargetRegions`
	//
	// - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.
	// - **Patch Policy (Type: AWS QuickSetupType-PatchPolicy)** - - `PatchPolicyName`
	//
	// - Description: (Required) A name for the patch policy. The value you provide is applied to target Amazon EC2 instances as a tag.
	// - `SelectedPatchBaselines`
	//
	// - Description: (Required) An array of JSON objects containing the information for the patch baselines to include in your patch policy.
	// - `PatchBaselineUseDefault`
	//
	// - Description: (Optional) A boolean value that determines whether the selected patch baselines are all AWS provided.
	// - `ConfigurationOptionsPatchOperation`
	//
	// - Description: (Optional) Determines whether target instances scan for available patches, or scan and install available patches. The valid values are `Scan` and `ScanAndInstall` . The default value for the parameter is `Scan` .
	// - `ConfigurationOptionsScanValue`
	//
	// - Description: (Optional) A cron expression that is used as the schedule for when instances scan for available patches.
	// - `ConfigurationOptionsInstallValue`
	//
	// - Description: (Optional) A cron expression that is used as the schedule for when instances install available patches.
	// - `ConfigurationOptionsScanNextInterval`
	//
	// - Description: (Optional) A boolean value that determines whether instances should scan for available patches at the next cron interval. The default value is " `false` ".
	// - `ConfigurationOptionsInstallNextInterval`
	//
	// - Description: (Optional) A boolean value that determines whether instances should scan for available patches at the next cron interval. The default value is " `false` ".
	// - `RebootOption`
	//
	// - Description: (Optional) A boolean value that determines whether instances are rebooted after patches are installed. The default value is " `false` ".
	// - `IsPolicyAttachAllowed`
	//
	// - Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " `false` ".
	// - `OutputLogEnableS3`
	//
	// - Description: (Optional) A boolean value that determines whether command output logs are sent to Amazon S3.
	// - `OutputS3Location`
	//
	// - Description: (Optional) A JSON string containing information about the Amazon S3 bucket where you want to store the output details of the request.
	//
	// - `OutputS3BucketRegion`
	//
	// - Description: (Optional) The AWS Region where the Amazon S3 bucket you want AWS Config to deliver command output to is located.
	// - `OutputS3BucketName`
	//
	// - Description: (Optional) The name of the Amazon S3 bucket you want AWS Config to deliver command output to.
	// - `OutputS3KeyPrefix`
	//
	// - Description: (Optional) The key prefix you want to use in the custom Amazon S3 bucket.
	// - `TargetType`
	//
	// - Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are `*` , `InstanceIds` , `ResourceGroups` , and `Tags` . Use `*` to target all instances in the account.
	// - `TargetInstances`
	//
	// - Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify `InstanceIds` for the `TargetType` parameter.
	// - `TargetTagKey`
	//
	// - Description: (Required) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify `Tags` for the `TargetType` parameter.
	// - `TargetTagValue`
	//
	// - Description: (Required) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify `Tags` for the `TargetType` parameter.
	// - `ResourceGroupName`
	//
	// - Description: (Required) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify `ResourceGroups` for the `TargetType` parameter.
	// - `TargetAccounts`
	//
	// - Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either `TargetAccounts` or `TargetOrganizationalUnits` .
	// - `TargetOrganizationalUnits`
	//
	// - Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
	// - `TargetRegions`
	//
	// - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-configurationdefinition.html#cfn-ssmquicksetup-configurationmanager-configurationdefinition-parameters
	//
	Parameters interface{} `field:"required" json:"parameters" yaml:"parameters"`
	// The type of the Quick Setup configuration.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-configurationdefinition.html#cfn-ssmquicksetup-configurationmanager-configurationdefinition-type
	//
	Type *string `field:"required" json:"type" yaml:"type"`
	// The ID of the configuration definition.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-configurationdefinition.html#cfn-ssmquicksetup-configurationmanager-configurationdefinition-id
	//
	Id *string `field:"optional" json:"id" yaml:"id"`
	// The ARN of the IAM role used to administrate local configuration deployments.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-configurationdefinition.html#cfn-ssmquicksetup-configurationmanager-configurationdefinition-localdeploymentadministrationrolearn
	//
	LocalDeploymentAdministrationRoleArn *string `field:"optional" json:"localDeploymentAdministrationRoleArn" yaml:"localDeploymentAdministrationRoleArn"`
	// The name of the IAM role used to deploy local configurations.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-configurationdefinition.html#cfn-ssmquicksetup-configurationmanager-configurationdefinition-localdeploymentexecutionrolename
	//
	LocalDeploymentExecutionRoleName *string `field:"optional" json:"localDeploymentExecutionRoleName" yaml:"localDeploymentExecutionRoleName"`
	// The version of the Quick Setup type used.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-configurationdefinition.html#cfn-ssmquicksetup-configurationmanager-configurationdefinition-typeversion
	//
	TypeVersion *string `field:"optional" json:"typeVersion" yaml:"typeVersion"`
}

The definition of a Quick Setup configuration.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

configurationDefinitionProperty := &ConfigurationDefinitionProperty{
	Parameters: map[string]*string{
		"parametersKey": jsii.String("parameters"),
	},
	Type: jsii.String("type"),

	// the properties below are optional
	Id: jsii.String("id"),
	LocalDeploymentAdministrationRoleArn: jsii.String("localDeploymentAdministrationRoleArn"),
	LocalDeploymentExecutionRoleName: jsii.String("localDeploymentExecutionRoleName"),
	TypeVersion: jsii.String("typeVersion"),
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-configurationdefinition.html

type CfnConfigurationManager_StatusSummaryProperty 

type CfnConfigurationManager_StatusSummaryProperty struct {
	// The datetime stamp when the status was last updated.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-statussummary.html#cfn-ssmquicksetup-configurationmanager-statussummary-lastupdatedat
	//
	LastUpdatedAt *string `field:"required" json:"lastUpdatedAt" yaml:"lastUpdatedAt"`
	// The type of a status summary.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-statussummary.html#cfn-ssmquicksetup-configurationmanager-statussummary-statustype
	//
	StatusType *string `field:"required" json:"statusType" yaml:"statusType"`
	// The current status.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-statussummary.html#cfn-ssmquicksetup-configurationmanager-statussummary-status
	//
	Status *string `field:"optional" json:"status" yaml:"status"`
	// Details about the status.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-statussummary.html#cfn-ssmquicksetup-configurationmanager-statussummary-statusdetails
	//
	StatusDetails interface{} `field:"optional" json:"statusDetails" yaml:"statusDetails"`
	// When applicable, returns an informational message relevant to the current status and status type of the status summary object.
	//
	// We don't recommend implementing parsing logic around this value since the messages returned can vary in format.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-statussummary.html#cfn-ssmquicksetup-configurationmanager-statussummary-statusmessage
	//
	StatusMessage *string `field:"optional" json:"statusMessage" yaml:"statusMessage"`
}

A summarized description of the status.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

statusSummaryProperty := &StatusSummaryProperty{
	LastUpdatedAt: jsii.String("lastUpdatedAt"),
	StatusType: jsii.String("statusType"),

	// the properties below are optional
	Status: jsii.String("status"),
	StatusDetails: map[string]*string{
		"statusDetailsKey": jsii.String("statusDetails"),
	},
	StatusMessage: jsii.String("statusMessage"),
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-statussummary.html

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.